Add a Job Client Status
This service adds a job client status to the job, by job Id or reference. These show on the Customer Activity tab, in the Activity tab, on jobs.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | JobClientStatus | Required |
JobId | Int | Id of the job. | Required |
JobReference | String | Reference of the job. | Required |
JobClientStatus | Int | Value of the required status to add to the job. See tooltip for valid values. | Required |
Comment | String | Comment to add to the status. | Optional |
tip
Either the Job Id or Reference can be supplied. If both parameters are provided, the Job Id will take precedence.
Response Codes
Code | Message | Information |
---|---|---|
0 | None | Completed Successfully |
2 | Missing or invalid Parameter - jobId or JobReference | Neither the JobId or JobReference parameter was provided, or was invalid. |
2 | Invalid Parameter - jobId | JobId parameter was provided, but with an invalid value. JobId must be numeric. |
2 | JobClientStatus parameter is missing. | JobClientStatus parameter was not provided. |
2 | Invalid parameter - JobClientStatus - positive integer expected. | JobClientStatus parameter was provided, but was not a positive integer. |
2 | Invalid parameter - JobClientStatus - invalid status value. | JobClientStatus parameter was provided, but was not a valid status value. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=JobClientStatus&JobId=128914195&JobClientStatus=5
Response Data
{ "Code": 0 }