find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amcs-group:amcs-group-schedule-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AMCS Platform REST Schedule API
  description: '![latest End points](/amcsrestapi/diagram/endpointslatest.svg)


    # Overview


    ## Who Should Read this Document


    This document contains a technical description of the AMCS Platform REST API. It is intended for:


    · System integrators


    · Customer IT team looking to integrate AMCS Platform with another system


    · Third parties looking to integrate their system with AMCS Platform


    ## Document Scope


    This document introduces the technical aspects of the AMCS Platform REST API. The purpose of this document is to provide readers with detail on how to:


    · Access the REST API


    · Make calls to the API to retrieve, append and update resources


    · Retrieve the incremental changes to a collection


    · Find more detail on the end points that are available from an environment. ## Summary


    AMCS Platform REST API is designed to support the integration of AMCS Platform with other systems. With care and additional infrastructure, the REST API can be used to build functionality on top of Platform but that is not it’s primary purpose. The ‘changes since’ process provides the main means of performing an initial synchronisation of the AMCS Platform and another system, and then keeping them synchronised. Methods are also provided to create and update resources. # Integration Patterns and Tools


    The AMCS Platform provides a number of tools that can be used to connect systems. Care should be taken to match the right tooling to the intended pattern of integration. · When an extract-based approach is needed, use BI reporting. · When derived values are require, use the data mart. · When business processes on different systems need to be integrated by synchronising the data on each through an event style interface, use the REST API. An integration using the REST API will need to take full responsibility for all aspects of the integration including:


    · Pulling change events from AMCS Platform


    · Filtering the changed resources for the ones that are of interest


    · Pulling additional resources from the REST API in order the retrieve all the properties needed by the destination


    · Mashing resources to create the complete view required


    · Translating that into the form required by the destination


    · Validating this to ensure it meet the entry rules of the destination


    · Pushing the result to the destination


    In the early stages of designing the interface care should be taken to ensure that the need for caching/staging has been considered. The changes since functionality is effectively a means of pulling create/change events from platform. The only filters available enable retrieval of related resources to build a view external to AMCS Platform


    # Basics


    The AMCS REST API provides a RESTful interface that allows access to the primary business resources of the AMCS platform. The interface follows general HATEOAS compliance principles. ## Quick start


    A quickstart walkthrough based on node.js and covering authentication and getting a page of customers can be found here. ## Interface definitions


    Swagger documentation for the end points available on an environment can be found at:


    Before 8.5: https://{environment domain name}/swagger/ui/index


    From 8.5: https://{environment domain name}/erp/api/swagger/ui/index


    ## HTTP Interface


    The following HTTP RESTful methods are provided as part of this API:


    · GET: Provides read access to retrieve details of one or more resources. · POST: Creates or updates a single resource or a set of resources. · PUT: Updates a single resource or a set of resources. Note:


    · DELETE methods are currently not provided as part of the API. The REST API URIs begin with


    https://{environment domain name}/erp/api/integrator/erp


    For example:

    https://prod.amcs-at-mycompany.com/erp/api/integrator/erp


    This should be used as the base of the URI.'
  version: latest
servers:
- url: https://ete-p5-tst-svc-core.amcsplatform.com/erp/api/integrator/erp
tags:
- name: Schedule
paths:
  /transport/schedules/changes:
    get:
      tags:
      - Schedule
      summary: Retrieve changes
      description: '| Property | Description |

        | ------------------------------------- | ----------------------------------------------------------------------------- |

        | GUID| The GUID associated to the schedule. |

        | ScheduledDate| The date associated to the schedule.|

        | Description| The description associated to the schedule.|

        | IsContainerSchedule| Is the schedule a container.|

        | Notes| The notes associated to the schedule.Filterable.|

        | LeaveYardTime| The leave yard time associated to the schedule.|

        | ReturnYardTime| The return yard time associated to the schedule.|

        | Driver.RelatedUserDriverGuid| The GUID associated to the related user driver.|

        | Driver.ClockOffDateTime| The clock off time associated to the driver.|

        | Driver.ClockOnDateTime| The clock on time associated to the driver.|

        | VehicleChecks.StartMileage| The start mileage associated to the vehicle.|

        | VehicleChecks.EndMileage| The end mileage associated to the vehicle.|

        | VehicleChecks.IsStartSafetyChecked| Is the start safety checked associated to the vehicle.|

        | VehicleChecks.StartNotes| The start notes associated to the vehicle.|

        | VehicleChecks.IsEndSafetyChecked| Is the end safety checked associated to the vehicle.|

        | VehicleChecks.EndNotes| The end notes associated to the vehicle.|

        | VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the vehicle.|

        | VehicleChecks.EndDefectTicketNo| The end defect ticket number for the vehicle.|

        | VehicleChecks.StartDefectCheckBySysUserId| The start defect check of the vehicle by user id.|

        | VehicleChecks.EndDefectCheckBySysUserId| The end defect check associated to the vehicle by user id.|

        | CompanyOutletListItem| The GUID and the description associated to the company outlet.|

        | IsCompleted| Is the schedule completed.|

        | IsForVehicle| Is the schedule for the vehicle.|

        | IsManifestCompleted| Is the manifest associated to the schedule completed.|

        | IsManifestExported| Is the manifest associated to the schedule exported.|

        | IsManifestExportedFailed| Is the manifest export associated to the schedule failed.|

        | IsManifestRequired| Is the manifest associated to the schedule required.|

        | IsThirdPartySchedule| Is the schedule a third party.|

        | FuelUsed| The fuel used associated to the schedule.|

        | FuelCost| The fuel cost associated to the schedule.|

        | Position| The position associated to the schedule.|

        | RelatedVehicleGuid| The GUID associated to the related vehicle. Filterable.|

        | RelatedUserDriverGuid| The GUID associated to the related user driver. Filterable.|

        | RelatedUserStartCheckByGuid| The GUID associated to the related user for start check. Filterable.|

        | RelatedUserEndCheckByGuid| The GUID associated to the related user for end check. Filterable.|'
      operationId: Schedule_GetChanges
      parameters:
      - name: since
        in: query
        schema:
          type: string
      - name: cursor
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceChanges_ApiIntegratorScheduleResource'
  /transport/schedules/{guid}:
    get:
      tags:
      - Schedule
      summary: Find with GUID
      description: '| Property | Description |

        | ------------------------------------- | ----------------------------------------------------------------------------- |

        | GUID| The GUID associated to the schedule. |

        | ScheduledDate| The date associated to the schedule.|

        | Description| The description associated to the schedule.|

        | IsContainerSchedule| Is the schedule a container.|

        | Notes| The notes associated to the schedule.Filterable.|

        | LeaveYardTime| The leave yard time associated to the schedule.|

        | ReturnYardTime| The return yard time associated to the schedule.|

        | Driver.RelatedUserDriverGuid| The GUID associated to the related user driver.|

        | Driver.ClockOffDateTime| The clock off time associated to the driver.|

        | Driver.ClockOnDateTime| The clock on time associated to the driver.|

        | VehicleChecks.StartMileage| The start mileage associated to the vehicle.|

        | VehicleChecks.EndMileage| The end mileage associated to the vehicle.|

        | VehicleChecks.IsStartSafetyChecked| Is the start safety checked associated to the vehicle.|

        | VehicleChecks.StartNotes| The start notes associated to the vehicle.|

        | VehicleChecks.IsEndSafetyChecked| Is the end safety checked associated to the vehicle.|

        | VehicleChecks.EndNotes| The end notes associated to the vehicle.|

        | VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the vehicle.|

        | VehicleChecks.EndDefectTicketNo| The end defect ticket number for the vehicle.|

        | VehicleChecks.StartDefectCheckBySysUserId| The start defect check of the vehicle by user id.|

        | VehicleChecks.EndDefectCheckBySysUserId| The end defect check associated to the vehicle by user id.|

        | CompanyOutletListItem| The GUID and the description associated to the company outlet.|

        | IsCompleted| Is the schedule completed.|

        | IsForVehicle| Is the schedule for the vehicle.|

        | IsManifestCompleted| Is the manifest associated to the schedule completed.|

        | IsManifestExported| Is the manifest associated to the schedule exported.|

        | IsManifestExportedFailed| Is the manifest export associated to the schedule failed.|

        | IsManifestRequired| Is the manifest associated to the schedule required.|

        | IsThirdPartySchedule| Is the schedule a third party.|

        | FuelUsed| The fuel used associated to the schedule.|

        | FuelCost| The fuel cost associated to the schedule.|

        | Position| The position associated to the schedule.|

        | RelatedVehicleGuid| The GUID associated to the related vehicle. Filterable.|

        | RelatedUserDriverGuid| The GUID associated to the related user driver. Filterable.|

        | RelatedUserStartCheckByGuid| The GUID associated to the related user for start check. Filterable.|

        | RelatedUserEndCheckByGuid| The GUID associated to the related user for end check. Filterable.|'
      operationId: Schedule_Get
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultEntity_ApiIntegratorScheduleResource'
    put:
      tags:
      - Schedule
      summary: Partial update
      description: '| Property | Description | Required |

        | ------------------------------------- | ----------------------------------------------------------------------------- | -------- |

        | GUID| The GUID associated to the schedule. | No |

        | ScheduledDate| The date associated to the schedule.| Yes |

        | Description| The description associated to the schedule.| Yes |

        | IsContainerSchedule| Is the schedule a container.| No |

        | Notes| The notes associated to the schedule. Editable.| No |

        | LeaveYardTime| The leave yard time associated to the schedule.| No |

        | ReturnYardTime| The return yard time associated to the schedule.| No |

        | Driver.RelatedUserDriverGuid| The GUID associated to the related user driver.| No |

        | Driver.ClockOffDateTime| The clock off time associated to the driver.| No |

        | Driver.ClockOnDateTime| The clock on time associated to the driver.| No |

        | VehicleChecks.StartMileage| The start mileage associated to the vehicle.| No |

        | VehicleChecks.EndMileage| The end mileage associated to the vehicle.| No |

        | VehicleChecks.IsStartSafetyChecked| Is the start safety checked associated to the vehicle.| No |

        | VehicleChecks.StartNotes| The start notes associated to the vehicle.| No |

        | VehicleChecks.IsEndSafetyChecked| Is the end safety checked associated to the vehicle.| No |

        | VehicleChecks.EndNotes| The end notes associated to the vehicle.| No |

        | VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the vehicle.| No |

        | VehicleChecks.EndDefectTicketNo| The end defect ticket number for the vehicle.| No |

        | VehicleChecks.StartDefectCheckBySysUserId| The start defect check of the vehicle by user id.| No |

        | VehicleChecks.EndDefectCheckBySysUserId| The end defect check associated to the vehicle by user id.| No |

        | CompanyOutletListItem| The GUID and the description associated to the company outlet.| Yes |

        | IsCompleted| Is the schedule completed.| Yes |

        | IsForVehicle| Is the schedule for the vehicle.| Yes |

        | IsManifestCompleted| Is the manifest associated to the schedule completed.| Yes |

        | IsManifestExported| Is the manifest associated to the schedule exported.| Yes |

        | IsManifestExportedFailed| Is the manifest export associated to the schedule failed.| Yes |

        | IsManifestRequired| Is the manifest associated to the schedule required.| Yes |

        | IsThirdPartySchedule| Is the schedule a third party.| Yes |

        | FuelUsed| The fuel used associated to the schedule.| No |

        | FuelCost| The fuel cost associated to the schedule.| No |

        | Position| The position associated to the schedule.| No |

        | RelatedVehicleGuid| The GUID associated to the related vehicle.| Yes |

        | RelatedUserDriverGuid| The GUID associated to the related user driver.| Yes |

        | RelatedUserStartCheckByGuid| The GUID associated to the related user for start check.| No |

        | RelatedUserEndCheckByGuid| The GUID associated to the related user for end check.| No |


        **Extra validations**


        | Condition | Error message |

        | --------- | ------------- |

        | If Description is more than 60 characters long | Description must be no more than 60 characters long. |

        | If Notes is more than 4096 characters long | Notes must be no more than 4096 characters long. |

        | If DefectTicketNo is more than 20 characters long | Defect Ticket No must be no more than 20 characters long. |

        | RelatedVehicleGuid is being edited | RelatedVehicleGuid is a read-only property. |

        | CompanyOutletListItem is being edited | CompanyOutletListItem.Guid is a read-only property. |

        | ScheduledDate is being edited | ScheduledDate is a read-only property. |

        | Description is being edited | Description is a read-only property. |

        | Position is being edited | Position is a read-only property. |

        | IsContainerSchedule is being edited | IsContainerSchedule is a read-only property. |

        | IsManifestRequired is being edited | IsManifestRequired is a read-only property. |

        | IsManifestCompleted is being edited | IsManifestCompleted is a read-only property.'
      operationId: Schedule_Update
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiIntegratorScheduleResource'
        required: true
        x-bodyName: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
  /transport/schedules:
    get:
      tags:
      - Schedule
      summary: Find with Filters
      description: '| Property | Description |

        | ------------------------------------- | ----------------------------------------------------------------------------- |

        | GUID| The GUID associated to the schedule. |

        | ScheduledDate| The date associated to the schedule.|

        | Description| The description associated to the schedule.|

        | IsContainerSchedule| Is the schedule a container.|

        | Notes| The notes associated to the schedule.Filterable.|

        | LeaveYardTime| The leave yard time associated to the schedule.|

        | ReturnYardTime| The return yard time associated to the schedule.|

        | Driver.RelatedUserDriverGuid| The GUID associated to the related user driver.|

        | Driver.ClockOffDateTime| The clock off time associated to the driver.|

        | Driver.ClockOnDateTime| The clock on time associated to the driver.|

        | VehicleChecks.StartMileage| The start mileage associated to the vehicle.|

        | VehicleChecks.EndMileage| The end mileage associated to the vehicle.|

        | VehicleChecks.IsStartSafetyChecked| Is the start safety checked associated to the vehicle.|

        | VehicleChecks.StartNotes| The start notes associated to the vehicle.|

        | VehicleChecks.IsEndSafetyChecked| Is the end safety checked associated to the vehicle.|

        | VehicleChecks.EndNotes| The end notes associated to the vehicle.|

        | VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the vehicle.|

        | VehicleChecks.EndDefectTicketNo| The end defect ticket number for the vehicle.|

        | VehicleChecks.StartDefectCheckBySysUserId| The start defect check of the vehicle by user id.|

        | VehicleChecks.EndDefectCheckBySysUserId| The end defect check associated to the vehicle by user id.|

        | CompanyOutletListItem| The GUID and the description associated to the company outlet.|

        | IsCompleted| Is the schedule completed.|

        | IsForVehicle| Is the schedule for the vehicle.|

        | IsManifestCompleted| Is the manifest associated to the schedule completed.|

        | IsManifestExported| Is the manifest associated to the schedule exported.|

        | IsManifestExportedFailed| Is the manifest export associated to the schedule failed.|

        | IsManifestRequired| Is the manifest associated to the schedule required.|

        | IsThirdPartySchedule| Is the schedule a third party.|

        | FuelUsed| The fuel used associated to the schedule.|

        | FuelCost| The fuel cost associated to the schedule.|

        | Position| The position associated to the schedule.|

        | RelatedVehicleGuid| The GUID associated to the related vehicle. Filterable.|

        | RelatedUserDriverGuid| The GUID associated to the related user driver. Filterable.|

        | RelatedUserStartCheckByGuid| The GUID associated to the related user for start check. Filterable.|

        | RelatedUserEndCheckByGuid| The GUID associated to the related user for end check. Filterable.|'
      operationId: Schedule_GetCollection
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: max
        in: query
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: includeCount
        in: query
        schema:
          type: boolean
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultCollection_ApiIntegratorScheduleResource'
    post:
      tags:
      - Schedule
      summary: Create or update
      description: '| Property | Description | Required |

        | ------------------------------------- | ----------------------------------------------------------------------------- | -------- |

        | GUID| The GUID associated to the schedule. | No |

        | ScheduledDate| The date associated to the schedule.| Yes |

        | Description| The description associated to the schedule.| Yes |

        | IsContainerSchedule| Is the schedule a container.| No |

        | Notes| The notes associated to the schedule.Editable.| No |

        | LeaveYardTime| The leave yard time associated to the schedule.| No |

        | ReturnYardTime| The return yard time associated to the schedule.| No |

        | Driver.RelatedUserDriverGuid| The GUID associated to the related user driver.| No |

        | Driver.ClockOffDateTime| The clock off time associated to the driver.| No |

        | Driver.ClockOnDateTime| The clock on time associated to the driver.| No |

        | VehicleChecks.StartMileage| The start mileage associated to the vehicle.| No |

        | VehicleChecks.EndMileage| The end mileage associated to the vehicle.| No |

        | VehicleChecks.IsStartSafetyChecked| Is the start safety checked associated to the vehicle.| No |

        | VehicleChecks.StartNotes| The start notes associated to the vehicle.| No |

        | VehicleChecks.IsEndSafetyChecked| Is the end safety checked associated to the vehicle.| No |

        | VehicleChecks.EndNotes| The end notes associated to the vehicle.| No |

        | VehicleChecks.StartDefectTicketNo| The start defect ticket number associated to the vehicle.| No |

        | VehicleChecks.EndDefectTicketNo| The end defect ticket number for the vehicle.| No |

        | VehicleChecks.StartDefectCheckBySysUserId| The start defect check of the vehicle by user id.| No |

        | VehicleChecks.EndDefectCheckBySysUserId| The end defect check associated to the vehicle by user id.| No |

        | CompanyOutletListItem| The GUID and the description associated to the company outlet.| Yes |

        | IsCompleted| Is the schedule completed.| Yes |

        | IsForVehicle| Is the schedule for the vehicle.| Yes |

        | IsManifestCompleted| Is the manifest associated to the schedule completed.| Yes |

        | IsManifestExported| Is the manifest associated to the schedule exported.| Yes |

        | IsManifestExportedFailed| Is the manifest export associated to the schedule failed.| Yes |

        | IsManifestRequired| Is the manifest associated to the schedule required.| Yes |

        | IsThirdPartySchedule| Is the schedule a third party.| Yes |

        | FuelUsed| The fuel used associated to the schedule.| No |

        | FuelCost| The fuel cost associated to the schedule.| No |

        | Position| The position associated to the schedule.| No |

        | RelatedVehicleGuid| The GUID associated to the related vehicle.| Yes |

        | RelatedUserDriverGuid| The GUID associated to the related user driver.| Yes |

        | RelatedUserStartCheckByGuid| The GUID associated to the related user for start check.| No |

        | RelatedUserEndCheckByGuid| The GUID associated to the related user for end check.| No |


        **Extra validations**


        | Condition | Error message |

        | --------- | ------------- |

        | If Description is more than 60 characters long | Description must be no more than 60 characters long. |

        | If Notes is more than 4096 characters long | Notes must be no more than 4096 characters long. |

        | If DefectTicketNo is more than 20 characters long | Defect Ticket No must be no more than 20 characters long. |

        | RelatedVehicleGuid is being edited | RelatedVehicleGuid is a read-only property. |

        | CompanyOutletListItem is being edited | CompanyOutletListItem.Guid is a read-only property. |

        | ScheduledDate is being edited | ScheduledDate is a read-only property. |

        | Description is being edited | Description is a read-only property. |

        | Position is being edited | Position is a read-only property. |

        | IsContainerSchedule is being edited | IsContainerSchedule is a read-only property. |

        | IsManifestRequired is being edited | IsManifestRequired is a read-only property. |

        | IsManifestCompleted is being edited | IsManifestCompleted is a read-only property.'
      operationId: Schedule_Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiIntegratorScheduleResource'
        required: true
        x-bodyName: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
components:
  schemas:
    ApiResourceChanges_ApiIntegratorScheduleResource:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorScheduleResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiIntegratorScheduleDriverResource:
      type: object
      properties:
        RelatedUserDriverGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        ClockOffDateTime:
          type: string
          format: zonedDateTime
          example:
            DateTime: '2000-01-01'
            TimeZone: Europe/London
        ClockOnDateTime:
          type: string
          format: zonedDateTime
          example:
            DateTime: '2000-01-01'
            TimeZone: Europe/London
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          type: integer
          format: int32
    ApiResourceResultEntity_ApiIntegratorScheduleResource:
      type: object
      properties:
        resource:
          $ref: '#/components/schemas/ApiIntegratorScheduleResource'
        links:
          $ref: '#/components/schemas/ApiResourceResultEntityLinks'
        extra:
          $ref: '#/components/schemas/ApiResourceResultEntityExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceResultEntityExtra:
      type: object
      properties:
        expand:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
        include:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
              additionalProperties:
                type: object
    ApiResourceResultEntityLinks:
      type: object
      properties:
        self:
          type: string
        associations:
          type: array
          items:
            type: string
        expand:
          type: array
          items:
            type: string
        operations:
          type: array
          items:
            type: string
    ApiResourceResultUpdatesExtra:
      type: object
      properties:
        until:
          type: string
        cursor:
          type: string
    ApiIntegratorScheduleVehicleCheckResource:
      type: object
      properties:
        StartMileage:
          type: number
          format: double
        EndMileage:
          type: number
          format: double
        IsStartSafetyChecked:
          type: boolean
        StartNotes:
          type: string
        IsEndSafetyChecked:
          type: boolean
        EndNotes:
          type: string
        StartDefectTicketNo:
          type: string
        EndDefectTicketNo:
          type: string
        RelatedUserStartCheckByGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedUserEndCheckByGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiIntegratorListItemResource:
      type: object
      properties:
        Description:
          type: string
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiResourceId:
      type: object
      properties:
        resource:
          type: string
          format: uuid
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceStatus:
      type: object
      properties:
        id:
          type: integer
          format: int32
        isSuccess:
          type: boolean
    ApiIntegratorScheduleResource:
      type: object
      properties:
        ScheduledDate:
          type: string
          format: localDate
          example: '2000-01-01'
        Description:
          type: string
        IsContainerSchedule:
          type: boolean
        Notes:
          type: string
        LeaveYardTime:
          type: string
          format: zonedDateTime
          example:
            DateTime: '2000-01-01'
            TimeZone: Europe/London
        ReturnYardTime:
          type: string
          format: zonedDateTime
          example:
            DateTime: '2000-01-01'
            TimeZone: Europe/London
        Driver:
          $ref: '#/components/schemas/ApiIntegratorScheduleDriverResource'
        VehicleChecks:
          $ref: '#/components/schemas/ApiIntegratorScheduleVehicleCheckResource'
        CompanyOutletListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        IsCompleted:
          type: boolean
        IsForVehicle:
          type: boolean
        IsManifestCompleted:
          type: boolean
        IsManifestExported:
          type: boolean
        IsManifestExportedFailed:
          type: boolean
        IsManifestRequired:
          type: boolean
        IsThirdPartySchedule:
          type: boolean
        FuelUsed:
          type: number
          format: double
        FuelCost:
          type: number
          format: double
        Position:
          type: integer
          format: int32
        RelatedVehicleGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedUserDriverGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedUserStartCheckByGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedUserEndCheckByGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        GUID:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiResourceResultCollection_ApiIntegratorScheduleResource:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorScheduleResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string