Get a Paged List of Jobs by Contact

Allows you to retrieve large numbers of job records, specifying the number of records returned in each page.

Query String Parameters

Name	Type	Description	Required
Action	String	JobsListByContactPaged	Required
ContactId	Int		Required
ContactRef	String	Use when ContactId is not supplied.	Required
Start	Date	Date to retrieve jobs from. Format: yyyy-MM-dd HH:mm:ss.	Required
End	Date	Date to retrieve jobs data to. Format: yyyy-MM-dd HH:mm:ss.	Required
JobStatus	String	Select one from: New, Scheduled, Unscheduled, Sent, Refused, OnTheWay, Started, Suspended, CompletedOk, CompletedNOK.	Required
Page	Int	Starts at 0.	Required
PageSize	Int	Minimum 1, maximum 5000.	Required
CheckContactDescendants	Bool	When true, the descendants of the supplied contact will be used to retrieve the jobs list. 1 = true, default is 0.	Optional

Response Codes

Code	Message	Information
2	error - jobViewAllocated
2	error - obViewUnallocated
2	error - pagesize
0	No results
0	returnedjobs
2	contactRef or contactId parameter required
2	page parameter required
2	pagesize parameter required
2	jobStatus parameter not a valid value: + queryString[jobStatus]

Example

Request

Request URL

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

Response

Response Data

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