Operations

Planner service

Staff or fleet service pending coverage, or already covered.

Schemas: PlannerServiceDto

{
  "orderServiceId": "string",
  "rowKind": "summary",
  "orderId": "string",
  "orderNumber": "string",
  "orderStatus": "string",
  "contactName": "Example",
  "projectId": "string",
  "projectName": "Example",
  "serviceId": "string",
  "serviceName": "Example",
  "serviceType": "string",
  "staffMemberId": "string",
  "vehicleId": "string",
  "startDate": "2026-09-01T08:00:00Z",
  "endDate": "2026-09-01T08:00:00Z",
  "status": "string",
  "qty": 1,
  "taskId": "string",
  "requirements": [
    {
      "requiredResourceType": "personnel",
      "qty": 1
    }
  ]
}

Generated from the schema

A staff or fleet service of an order that is pending coverage or already covered. When staffMemberId and vehicleId are null the service is uncovered. The identifier you use to assign it is orderServiceId, not an id. List the services of a date window with GET /api/v1/planner/services.

Attributes

orderServiceIdstring

Service line identifier. It is the one passed when assigning.

rowKindstring

Which row this is. A service comes as ONE summary row (the service itself, with staffMemberId and vehicleId always null) plus one detail row per person or vehicle assigned to it, all with the same orderServiceId. A service is covered when it has detail rows with an assignee, and uncovered when it only has the summary row.

Available options: summary, detail

orderIdstring

Order the service is attached to; an empty string on internal services, which belong to no order.

orderNumberstring

Human-readable number of that order; an empty string on internal services.

orderStatusstring

Order status.

contactNamestring | null

Customer of the order; null if not recorded.

projectIdstring | null

Associated project; null if not applicable.

projectNamestring | null

Project name; null if not applicable.

serviceIdstring

Catalogue service it comes from.

serviceNamestring

Service name.

serviceTypestring

Type: crew, fleet or general.

staffMemberIdstring | null

Assigned staff member. Only detail rows carry it; it is null on the summary row even when the service is covered.

vehicleIdstring | null

Assigned vehicle. Only detail rows carry it; it is null on the summary row even when the service is covered.

startDatestring<date-time>

Service start in ISO 8601 UTC.

endDatestring<date-time>

Service end in ISO 8601 UTC.

statusstring

Service line status.

qtynumber

How many units of the service are requested.

taskIdstring | null

Linked schedule task; null if there is none.

requirementsobject[]

Resources needed to cover it.

Show child attributes

requirements.requiredResourceTypestring

What is needed: personnel or vehicle.

Available options: personnel, vehicle

requirements.qtynumber

How many are needed.

Values

rowKind: summary, detail

Returned by

GET /api/v1/planner/services — List the services to cover

Modified by

No operation.

Was this page helpful?