Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

JobGroups

Get a job group

Retrieve the details of a single job group (required scope jobs:read)

get/v1/jobGroups/{jobGroupId}

Path parameters

jobGroupIdinteger required

The unique identifier of the job group

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the job group

referencestring

The internal reference of a job group - should usually be unique

contactIdinteger

The unique identifier of the contact the job group is for

contactNamestring nullable

The name of the contact the job group is for

contactAddressstring nullable

The postal address of the contact the job group is for

personIdstring uuid nullable

The unique uuid identifier of the person who will serve as primary point of contact for the job

personNamestring nullable

The name of the person who will serve as primary point of contact for the job

titlestring

The title of the job group

isShownOnDeviceboolean

Indicates whether the job group is shown on the device

areJobsLinkedboolean

Indicates whether the jobs in the group are linked

createdAtstring date-time

The UTC timestamp for when the job group was created

orderNumberstring nullable

The order number associated with the job group

plannedStartOption'onSetDate' | 'dateOfFirstJob'

Represents the options for setting the planned start date of a job group<p>Possible values:</p><ul><li><b>onSetDate</b>: On a specific date</li><li><b>dateOfFirstJob</b>: The date of the first job in the job group</li></ul>

plannedStartAtstring date-time nullable

The UTC Timestamp for when the job group is planned to start. Only set if the BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.PlannedStartOption is BigChange.BO.RestApi.Application.JobGroups.Enumerations.JobGroupPlannedStartOptions.OnSetDate

plannedEndOption'onSetDate' | 'dateOfLastJob'

Represents the options for setting the planned end date of a job group<p>Possible values:</p><ul><li><b>onSetDate</b>: On a specific date</li><li><b>dateOfLastJob</b>: The date of the last job in the job group</li></ul>

plannedEndAtstring date-time nullable

The UTC timestamp for when the job group should be ended. Only set if the BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.PlannedEndOption is BigChange.BO.RestApi.Application.JobGroups.Enumerations.JobGroupPlannedEndOptions.OnSetDate

status'unscheduled' | 'partScheduled' | 'scheduled' | 'inProgress' | 'completed' | 'financiallyCompleted'

Represents the status of a job group<p>Possible values:</p><ul><li><b>unscheduled</b>: Job group is unscheduled</li><li><b>partScheduled</b>: Part of the job group is scheduled</li><li><b>scheduled</b>: Job group is scheduled</li><li><b>inProgress</b>: Job group is in progress</li><li><b>completed</b>: Job group is completed</li><li><b>financiallyCompleted</b>: Job group is financially completed</li></ul>

categoryIdinteger nullable

The unique identifier of the category that the job group is assigned to

categoryNamestring nullable

The name of the category that the job group is assigned to

contractIdinteger nullable

The unique identifier of the contract that the job group is associated with

linkedJobsResourceNamestring nullable

The name of the resource associated with the job group. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is true

linkedJobsResourceIdinteger nullable

The unique identifier of the resource who will be actioning the job group. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is true

linkedJobsVehicleRegistrationstring nullable

The registration number of the vehicle associated with the job group. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is true

linkedJobsVehicleIdinteger nullable

The unique identifier of the vehicle associated with the job group. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is true

linkedJobsStartAtstring date-time nullable

The UTC timestamp for when the job group is started. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is true

ownerIdinteger nullable

The unique identifier of the user who owns the job group

Example response

{
  "id": 123456789,
  "reference": "ABC/12345",
  "contactId": 12345678,
  "contactName": "John Doe",
  "contactAddress": "3150 Century Way, Leeds LS15 6HU",
  "contactLocation": {
    "latitude": 51.31349,
    "longitude": -0.7464233
  },
  "personId": "123e4567-e89b-12d3-a456-426614174000",
  "personName": "Peter Brown",
  "title": "My Group Job",
  "areJobsLinked": true,
  "createdAt": "2025-01-24T12:00:00.0000000+00:00",
  "orderNumber": "ORD123456",
  "plannedStartOption": "onSetDate",
  "plannedStartAt": "2025-01-01T09:00:00.0000000+00:00",
  "plannedEndOption": "onSetDate",
  "plannedEndAt": "2025-01-01T09:00:00.0000000+00:00",
  "status": "unscheduled",
  "categoryId": 123456,
  "categoryName": "Global Solutions Ltd",
  "contractId": 123456,
  "linkedJobsResourceName": "John Doe",
  "linkedJobsResourceId": 1234567,
  "linkedJobsVehicleRegistration": "AB12 CDE",
  "linkedJobsVehicleId": 123456,
  "linkedJobsStartAt": "2025-01-01T09:00:00.0000000+00:00",
  "ownerId": 12345
}