Add a Job Status to a Job
Apply a job status to a job.
Name | Type | Description | Required |
---|---|---|---|
Action | String | JobStatusSave | Required |
JsId | Int | Job status Id. Supply this to update an existing job status. | Required when updating |
JobId | Int | The unique identifier of the job, which can be retrieved using any of the methods listed under add something here. | Required |
JobRef | String | The reference of the job that is input as free text. | Required |
Status | Int | The status Id. | Required |
Comment | String | Add comment text. | Optional |
DateTime | DateTime | yyyy-MM-dd hh:mm:ss format, or 'now' for current time. | Required |
WithAlert | Bool | Send alert to devices. | Optional |
note
Either the Job Id or Reference can be supplied. If both parameters are provided, the Job Id will take precedence.
JsId will take precedence over a Job Id or Reference.
JsId will take precedence over a Job Id or Reference.
Response Codes
Code | Message | Information |
---|---|---|
0 | null | |
2 | Invalid or missing parameter - status | |
2 | Missing DateTime parameter | |
2 | Invalid DateTime | |
2 | Invalid JsId parameter | |
2 | Status not found | |
2 | JobId or JobRef parameter expected | |
2 | Provide JobId or JobRef parameter | |
2 | Invalid JobId parameter | |
2 | Job not found |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=JobStatusSave&JsId&JobId=12345678&DateTime=now&Status=12&Comment=Job Completed
Response Data
{ "Code": 0 }