Skip to main content

Add a Job Status to a Job

Apply a job status to a job.

NameTypeDescriptionRequired
ActionStringJobStatusSaveRequired
JsIdIntJob status Id. Supply this to update an existing job status.Required when updating
JobIdIntThe unique identifier of the job, which can be retrieved using any of the methods listed under add something here.Required
JobRefStringThe reference of the job that is input as free text.Required
StatusIntThe status Id.Required
CommentStringAdd comment text.Optional
DateTimeDateTimeyyyy-MM-dd hh:mm:ss format, or 'now' for current time.Required
WithAlertBoolSend 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.

Response Codes

CodeMessageInformation
0null
2Invalid or missing parameter - status
2Missing DateTime parameter
2Invalid DateTime
2Invalid JsId parameter
2Status not found
2JobId or JobRef parameter expected
2Provide JobId or JobRef parameter
2Invalid JobId parameter
2Job not found

Example

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=JobStatusSave&JsId&JobId=12345678&DateTime=now&Status=12&Comment=Job Completed