Get a Job

This service returns the details of a single job using either the Job Id or the Job Reference.

Name	Type	Description	Required
Action	String	Job	Required
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
FlagHistory	Bool	Include the flags set against the job.	Optional
IncludeCancelled	Bool	Check for cancelled job with the supplied Id or Ref.	Optional
IncludeAssistants	Bool	Include assistant detail for the job.	Optional
JobPO	String	To search for a job using the PO number, use this parameter instead of JobId and JobRef. Must be used in conjunction with ContactId.	Optional
ExcludeJobStatusIds	String	A list of Ids separated by comma. Used to exclude specific job statuses:	Optional
ContactId	Int	Optional parameter when supplying JobPO only.	Optional
ContactParentId	Int	Optional parameter when supplying JobPO only.	Optional
IncludeWorksheets	Bool	Include detail of selected worksheets.	Optional
IncludeWSA	Bool	Include actual worksheet answers where available.	Optional
IncludeConstraints	Bool		Optional

note

RealStart, RealEnd, RealDuration, PrIntName, CustNote and ResNote are only returned if the job has been completed.

tip

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

Code	Message	Information
0	No results
0	GetJob(loggedUser
0	jobresult
0	jobList
2	JobId
2	Invalid or missing parameter - jobId
2	Invalid ContactParentId parameter.
2	Invalid ContactId parameter.

Request URL

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

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