Path parameters

• workOrderCode string Required

  Business code of the work order. Case insensitive.

Responses

• 200 application/json

  OK – Scheduling data for the requested work order.

  Hide response attributes Show response attributes object

  • schedule object Required

    Core scheduling block — time window and assigned field resources.

    Hide schedule attributes Show schedule attributes object

    • timeWindow object Required

      The time window during which the work order is planned to be executed. Both dates are in UTC, RFC 3339 format.

      Hide timeWindow attributes Show timeWindow attributes object

      • startDate string(date-time) Required

        Scheduled start date-time of the work order, UTC date-time notation as defined by RFC 3339, section 5.6.

      • endDate string(date-time) Required

        Scheduled end date-time of the work order, UTC date-time notation as defined by RFC 3339, section 5.6.

    • fieldResources object Required

      Field resources assigned to the work order. The main resource may be either a technician or a piece of equipment. Crew arrays are null when no additional resources are assigned.

      Hide fieldResources attributes Show fieldResources attributes object

      • mainResourceCode string Required

        Business code of the main resource assigned to the work order. Can be a technician code or an equipment code.

      • technicianCrewCodes array[string] | null

        Business codes of the additional technicians assigned alongside the main resource. Null when no additional technicians are assigned.

      • equipmentCrewCodes array[string] | null

        Business codes of the equipment assigned alongside the main resource. Null when no equipment is assigned.

  • customer object | null

    Customer-facing scheduling information: geolocated intervention site and appointment details communicated to the customer. The entire object is null when no customer-facing data is available. Individual fields are also independently nullable.

    Hide customer attributes Show customer attributes object | null

    • geolocation object | null

      GPS coordinates of the intervention site. Null when geolocation could not be determined.

      Hide geolocation attributes Show geolocation attributes object | null

      • lat number(double) Required

        Latitude of the intervention site.

      • lng number(double) Required

        Longitude of the intervention site.

    • appointment object | null

      Appointment details communicated to the customer. date and slot are independently nullable — one, both, or neither may be set depending on the scheduling configuration.

      Hide appointment attributes Show appointment attributes object | null

      • date string(date-time) | null

        Exact appointment date-time promised to the customer. Null if no precise appointment time was defined.

      • slot object | null

        Time slot communicated to the customer (e.g. "morning", "afternoon"). Null if no slot was defined.

        Hide slot attributes Show slot attributes object | null

        • startDate string(date-time) Required

          Start of the appointment slot, UTC date-time notation as defined by RFC 3339, section 5.6.

        • endDate string(date-time) Required

          End of the appointment slot, UTC date-time notation as defined by RFC 3339, section 5.6.

• 400 application/json

  Bad Request – The request is structurally invalid. For the uuid: variant, this is returned when the provided value is not a valid UUID format.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 401 application/json

  Unauthorized - authentication issue.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 403 application/json

  Forbidden - not enough rights.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 404 application/json

  Not Found – Work order does not exist, or exists but is not yet scheduled (status ≤ PRE-SCHEDULED).

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 429 application/json

  Too Many Requests.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].

• 500 application/json

  Internal server error.

  Hide response attributes Show response attributes object

  • errors array[object]

    Array of errors. Contains at least one element.

    Hide errors attributes Show errors attributes object

    Contains code and message for error.

    • code string Required
    • message string Required
  • errorReference string Required

    Error unique reference. Communicated to support, this will help to locate the issue.

    Format should match the following pattern: [0-1a-z].