Get a Job Group
This web service allows you retrieve details of a single job group together with the details of all jobs associated with that job group.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | JobsByGroup | Required |
JobGroupId | Int | Required. See Note | |
JobGroupRef | String | Required. See Note. | |
IncludeJobAssistants | Bool | Include assistant detail for the jobs within the group. Defaults to false. | Optional |
IncludeJobCustomFields | Bool | Include custom fields for the jobs within the group. Defaults to false. | Optional |
IncludeJobRestrictions | Bool | Include restrictions for the jobs within the group. Defaults to false. | Optional |
IncludeJobConstraints | Bool | Include constraints for the jobs within the group. Defaults to false. | Optional |
tip
Restrictions and constraints are the same. Both options are include for legacy purposes.
note
Either the JobGroup Reference or JobGroup ID can be supplied. If both parameters are provided, the JobGroup ID will take precedence.
Response Codes
Code | Message | Information |
---|---|---|
0 | jobG | |
2 | misc_noRight | |
2 | jobGroupRef or jobGroupId parameter required | |
2 | Invalid jobGroupId parameter | |
2 | JobGroup not found |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=jobsbygroup
Response Data
{ "Code": 0, "Result": [ { "AssetCheckId": "12345" } ] }