Cancel a Job

This web service allows you to cancel or permanently delete a job using a reference or a job Id.

Query String Parameters

Name	Type	Description	Required
Action	String	JobCancel	Required
JobId	Int	The unique identifier of the job, which can be retrieved using any of the methods listed under add something here.	Required - See Tip
JobReference	String	The reference of the job that is input as free text.	Required - See Tip
CancelRecurringJobs	Bool	Allows you to cancel the recurring jobs.	Optional
CancelReason	String	Allows you to add a cancellation note.	Optional
KeepJob	Bool	Allows you to permanently delete the job. See note.	Optional

tip

Either the Job Id or Reference can be supplied. If both parameters are provided, the Job Id will take precedence.

note

The default for this parameter is true. Setting this parameter to false will allow you to delete the job from your records. This deletes any record that the job existed.

Response Codes

Code	Message	Information
0	new { jobId = j.JobId }
0	null
2	Missing parameter - jobId or jobRef
2	Cannot find job

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=jobcancel

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "AssetCheckId": "12345"
    }
  ]
}