Skip to main content

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

NameTypeDescriptionRequired
ActionStringJobsByGroupRequired
JobGroupIdIntRequired. See Note
JobGroupRefStringRequired. See Note.
IncludeJobAssistantsBoolInclude assistant detail for the jobs within the group. Defaults to false.Optional
IncludeJobCustomFieldsBoolInclude custom fields for the jobs within the group. Defaults to false.Optional
IncludeJobRestrictionsBoolInclude restrictions for the jobs within the group. Defaults to false.Optional
IncludeJobConstraintsBoolInclude 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

CodeMessageInformation
0jobG
2misc_noRight
2jobGroupRef or jobGroupId parameter required
2Invalid jobGroupId parameter
2JobGroup not found

Example

Request URL

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