Operations

Schedule

Consolidated schedule of a date window.

Schemas: ScheduleDto

{
  "projects": [
    {
      "id": "id_8f2a1c",
      "name": "Example",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "status": "string"
    }
  ],
  "orders": [
    {
      "id": "id_8f2a1c",
      "orderNumber": "string",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "status": "string",
      "contactName": "Example",
      "projectName": "Example"
    }
  ],
  "tasks": [
    {
      "id": "id_8f2a1c",
      "title": "Example",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "isAllDay": true,
      "isCompleted": true,
      "type": "string",
      "projectId": "string",
      "assignedStaff": [
        {
          "id": "id_8f2a1c",
          "fullName": "Example"
        }
      ]
    }
  ],
  "internalServices": [
    {
      "id": "id_8f2a1c",
      "title": "Example",
      "serviceType": "string",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "projectName": "Example",
      "qty": 1,
      "assignedStaff": [
        {
          "id": "id_8f2a1c",
          "fullName": "Example"
        }
      ],
      "assignedVehicleIds": [
        "string"
      ]
    }
  ],
  "orderServices": [
    {
      "orderId": "string",
      "orderNumber": "string",
      "serviceName": "Example",
      "serviceType": "string",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "contactName": "Example",
      "projectName": "Example",
      "qty": 1,
      "assignedCount": 1,
      "assignedStaff": [
        {
          "id": "id_8f2a1c",
          "fullName": "Example"
        }
      ]
    }
  ]
}

Generated from the schema

The consolidated schedule of a date window: projects, orders, tasks, internal services and order services. It is read-only and it is a projection of those entities, not a resource you write. It is bounded by dates and does not paginate. Assignees come out by identifier and name, without contact details. Read it with GET /api/v1/schedule.

Attributes

projectsobject[]

Projects that fall within the window.

Show child attributes

projects.idstring

projects.namestring

projects.startDatestring<date-time>

projects.endDatestring<date-time>

projects.statusstring

ordersobject[]

Orders that fall within the window.

Show child attributes

orders.idstring

orders.orderNumberstring

orders.startDatestring<date-time>

orders.endDatestring<date-time>

orders.statusstring

orders.contactNamestring | null

orders.projectNamestring | null

tasksobject[]

Schedule tasks. Without the contact data of whoever they are assigned to.

Show child attributes

tasks.idstring

tasks.titlestring

tasks.startDatestring<date-time> | null

tasks.endDatestring<date-time> | null

tasks.isAllDayboolean

tasks.isCompletedboolean

tasks.typestring | null

tasks.projectIdstring | null

tasks.assignedStaffobject[]

Show child attributes

tasks.assignedStaff.idstring

Staff member identifier.

tasks.assignedStaff.fullNamestring

Name shown in the schedule.

internalServicesobject[]

Assignments not attached to an order.

Show child attributes

internalServices.idstring

internalServices.titlestring

internalServices.serviceTypestring

internalServices.startDatestring<date-time>

internalServices.endDatestring<date-time>

internalServices.projectNamestring | null

internalServices.qtynumber

internalServices.assignedStaffobject[]

Show child attributes

internalServices.assignedStaff.idstring

Staff member identifier.

internalServices.assignedStaff.fullNamestring

Name shown in the schedule.

internalServices.assignedVehicleIdsstring[]

orderServicesobject[]

Staff and fleet services attached to an order.

Show child attributes

orderServices.orderIdstring

orderServices.orderNumberstring

orderServices.serviceNamestring

orderServices.serviceTypestring

orderServices.startDatestring<date-time>

orderServices.endDatestring<date-time>

orderServices.contactNamestring | null

orderServices.projectNamestring | null

orderServices.qtynumber

orderServices.assignedCountnumber

orderServices.assignedStaffobject[]

Show child attributes

orderServices.assignedStaff.idstring

Staff member identifier.

orderServices.assignedStaff.fullNamestring

Name shown in the schedule.

Returned by

GET /api/v1/schedule — Get the schedule for a range

Modified by

No operation.

Was this page helpful?