Get a List of Jobs
Retrieving jobs.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | Jobs | Required |
Start | Date | Jobs data from. Format: yyyy-MM-dd HH:mm:ss. | Required |
End | Date | Jobs data to. Format: yyyy-MM-dd HH:mm:ss. | Required |
MyJobs | Bool | Return only jobs for the current logged in user. Use 1 for true, 0 for false. Defaults to false. | Optional |
Unallocated | Bool | Return unallocated jobs in the results. Default = true. | Optional |
Completed | Bool | Return completed jobs in the results Default = true. | Optional |
OnlyCancelled | Bool | If set, service will only return cancelled jobs. Default = false. | Optional |
StatusDate | Date | Minimum date of jobs current status. Can be used to retrieve only jobs that have changed status since the date supplied. Must be in format: yyyy-MM-dd HH:mm:ss. | Optional |
UseCreatedDate | Bool | When true, the creation date is used for the date filtering. When false, or not specified the job start/end date is used. Default = false | Optional |
IncludeAssistants | Bool | Include assistant detail for the Job. Default is false. | Optional |
IncludeCustomFields | Bool | Include custom fields for the Job. Default is false. | Optional |
note
- RealStart, RealEnd, RealDuration, PrIntName, CustNote and ResNote are only returned if a job is completed
Response Codes
Code | Message | Information |
---|---|---|
2 | start and end parameters expected |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=jobs
Response Data
{ "Code": 0, "Result": [ { "AssetCheckId": "12345" } ] }