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
Name | Type | Description | Required |
---|---|---|---|
Action | String | JobGroupDetailUpdate | Required |
JobGroupReference | String | The Group Job Reference. | Required. See Note. |
JobGroupId | Int | The Id of the group job to be updated. | Required. See Note. |
NewJobGroupOwnerTitle | String | The title to be set for the chosen group job. | Optional |
NewJobGroupOwnerEmail | String | The email address of the user chosen to be the new owner of the group job. | Optional |
NewJobGroupStatus | Int | Sets the group job status. | Optional |
NewPlannedStartDate | DateTime | Sets the group job start date to ‘On a set date’ with the date passed. Format yyyy-MM-dd. | Optional |
NewPlannedEndDate | DateTime | Sets the group job end date to ‘On a set date’ with the date passed. Format yyyy-MM-dd. | Optional |
JobGroupShowOnDevice | Bool | Set 'jobs appear in group on device' tick-box in UI | Optional |
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
Code | Message | Information |
---|---|---|
2 | !loggedUser.HasRightToDoAction(BigAction.Key_jobViewAllocated | |
2 | !loggedUser.HasRightToDoAction(BigAction.Key_jobViewUnallocated | |
2 | !loggedUser.HasRightToDoAction(BigAction.Key_jobCreateEdit | |
0 | Provided fields updated succesfully | |
2 | Missing parameter - jobGroupId or jobGroupReference | |
2 | Invalid Parameter - jobGroupId | |
2 | Cannot find jobGroup | |
2 | Cannot find user for newJobGroupOwner with the email provided | |
2 | Unable to parse newJobGroupStatus parameter | |
2 | Unable to parse newPlannedStartDate as DateTime | |
2 | Unable to parse newPlannedEndDate as DateTime | |
2 | Please enter a planned end date that occurs after the planned start date |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=jobgroupdetailupdate
Response Data
{ "Code": 0, "Result": [ { "AssetCheckId": "12345" } ] }