GetJobsBySynchronisationResult
From
(Difference between revisions)
(→Description) |
(→Success Mode) |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| − | Returns an array of [[JobCustomerBean]] for job which has an ID in the external record matching the value specified in the synchronisationReference parameter and has been synchronised to the organisation (flag) specified in the synchronisationID parameter. | + | Returns an array of [[JobCustomerBean]] for job(s) which has an ID in the external record matching the value specified in the synchronisationReference parameter and has been synchronised to the organisation (flag) specified in the synchronisationID parameter. |
== Success Mode == | == Success Mode == | ||
| − | Returns an | + | Returns an array of zero or more [[JobCustomerBean]] in the jobs field which match the criteria described above. The field may also be null, indicating there was no record found. |
== Failure Modes == | == Failure Modes == | ||
Latest revision as of 22:06, 3 January 2006
[edit] Description
Returns an array of JobCustomerBean for job(s) which has an ID in the external record matching the value specified in the synchronisationReference parameter and has been synchronised to the organisation (flag) specified in the synchronisationID parameter.
[edit] Success Mode
Returns an array of zero or more JobCustomerBean in the jobs field which match the criteria described above. The field may also be null, indicating there was no record found.
[edit] Failure Modes
One or more failure fields will be populated with a failure object (will contain a non-null reference) indicating the nature of the failure, with relevant information.
| Type | Description |
|---|---|
| AccessDeniedFailure | The username or password was incorrect, or lacked the right to complete this function. |
| ValidationFailure | One or more fields contained invalid values. |
