Skip to main content

Update Job Group Details

Update Job Group title, owner, status and/or planned dates.

The JobGroupDetailUpdate webservice allows users to update the Job Group title, owner, status and/or planned date fields of a group job. The user will need the following rights for this request to work correctly: view allocated jobs, view unallocated jobs and create/edit jobs. If a key is accidentally provided without a value, any existing old values will be kept and will not be overwritten with an empty value.

Query String Parameters

NameTypeDescriptionRequired
ActionStringJobGroupDetailUpdateRequired
JobGroupReferenceStringThe Group Job Reference.Required. See Note.
JobGroupIdIntThe Id of the group job to be updated.Required. See Note.
NewJobGroupOwnerTitleStringThe title to be set for the chosen group job.Optional
NewJobGroupOwnerEmailStringThe email address of the user chosen to be the new owner of the group job.Optional
NewJobGroupStatusIntSets the group job status. Optional
NewPlannedStartDateDateTimeSets the group job start date to ‘On a set date’ with the date passed. Format yyyy-MM-dd.Optional
NewPlannedEndDateDateTimeSets the group job end date to ‘On a set date’ with the date passed. Format yyyy-MM-dd.Optional
JobGroupShowOnDeviceBoolSet 'jobs appear in group on device' tick-box in UIOptional
note
Either the JobGroup Reference or JobGroup ID can be supplied. If both parameters are provided, the JobGroup ID will take precedence.
tip

NewJobGroupOwnerTitle
If you wish to clear an existing title field using this parameter, simply pass a single space as the parameters value e.g. " ".

Response Codes

CodeMessageInformation
2!loggedUser.HasRightToDoAction(BigAction.Key_jobViewAllocated
2!loggedUser.HasRightToDoAction(BigAction.Key_jobViewUnallocated
2!loggedUser.HasRightToDoAction(BigAction.Key_jobCreateEdit
0Provided fields updated succesfully
2Missing parameter - jobGroupId or jobGroupReference
2Invalid Parameter - jobGroupId
2Cannot find jobGroup
2Cannot find user for newJobGroupOwner with the email provided
2Unable to parse newJobGroupStatus parameter
2Unable to parse newPlannedStartDate as DateTime
2Unable to parse newPlannedEndDate as DateTime
2Please enter a planned end date that occurs after the planned start date

Example

Request URL

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