Loadsmart YMS - Yard View API

The YMS - Yard View API from Loadsmart — 4 operation(s) for yms - yard view.

GitHub OpenAPI
Business capability
Yard and Stack Management BC-2470.20

Operations 4

GET /yard/view/spot-grid Get lean spot grid data optimized for grid view rendering #
GET /yard/view/waiting-assets Get asset visits and containers waiting for spot assignment #
GET /yard/view/list-rows Get flattened list view rows (one row per container or truckless visit) #
GET /yard/view/spot-detail Get full spot detail for drawer: spot, task, assignment, and when applicable… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/loadsmart:loadsmart-yms-yard-view-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.

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

OpenAPI Specification

loadsmart-yms-yard-view-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Opendock Nova API Documentation YMS - Yard View API
  description: '## Welcome to Opendock Nova! #### What is Opendock Nova? Opendock is an online dock appointment scheduling tool. Facilities such as warehouses, distribution centers, and

    manufacturing plants use it to organize their docks and schedule appointments for outbound pickups and inbound

    deliveries. You can read all our knowledge base

    articles here. We now provide an SSO option for User Authentication. Read

    the docs here. ---


    ## Our APIs


    We have 3 main APIs:


    - REST API called _Neutron_ for performing standard HTTP operations. - Real-time API called _Subspace_ for receiving streaming events whenever objects are Created/Updated/Deleted. - A **"Reference Number Validation"** aka "PO Validation" _protocol_ for validating PO numbers (or similar) before an

    appointment is scheduled. Detailed documentation for it can be found

    here: PO/Ref Number Validation Implementation


    ---


    ## Neutron - REST API


    All endpoints are listed below. Depending on your User Role, some may be forbidden. Almost all endpoints expect a simple

    JWT token to be set in the `Authorization: Bearer` HTTP header. Read more about Bearer

    tokens here. ### Base URL


    The base URL is the same as it is for this document (look at the current URL in your browser''s address bar). For

    example, our production Neutron Base URL is https://neutron.opendock.com. ### Authentication


    To start, call the `POST /auth/login` endpoint to exchange your user credentials (email + password) for a simple JWT

    token. If you don''t have an account yet, reach out to your account admin or contact us for further help. If login is successful, the response will be a JWT token to use as your `Bearer` header as described above. The JWT expiration time depends on your User Role as well as other factors. You may base64-decode your JWT token to view

    more technical details about it. #### Test it:


    To test that your auth headers are set correctly, call the `GET /auth/me` endpoint. It will return a JSON payload with

    your User information. ---


    ## Subspace - Real-time Streaming API


    Subspace is a _read-only_ API that allows your system to recieve streaming real-time information about changes to your

    Appointments, Warehouses, Docks, etc. Using Subspace you can implement a "push"-based approach to your integration instead of relying only on "poll"-ing

    methods (which can be inefficient). Subpsace is based on the famous `socket.io` library. ### Choosing a socket.io Client


    The socket.io project provides a JavaScript client library that works in the browser as well as NodeJS. However there

    are also client implementations in many other languages including C#, Java, Python, and Go, so you should select the

    appropriate client for your project. A good overview of socket.io and a list of client implementations can be found

    here: Socket.IO Introduction


    **NOTE:** Currently Opendock uses socket.io server **v4.x** so please make sure to select an appropriate socket.io

    client version that is protocol compatible. ### Connecting and Authentication


    The base connection URL is the same as the base URL for Neutron above, except with the word "subspace" instead of "

    neutron". For example, our production Subspace connection URL

    is wss://subspace.opendock.com. For convenience, the same JWT token obtained from the Neutron `/auth/login` endpoint above is used for Subspace

    authentication. Connecting and Authenticating are done in a single operation: simply connect to the following `wss` URL:


    ```

    ?token=

    ```


    That can be a little confusing to parse. Here''s a real-life example connection string:


    ```

    wss://subspace.opendock.com?token=eyJhbGciOiJIUzI1Ni...(full token continues)

    ```


    **NOTE:** Currently Opendock only supports the `websocket` transport, so you must specify this in your connection

    settings. Here''s an example of connecting to Subspace using the JavaScript client:


    ```JavaScript

    // NOTE: we assume "accessToken" was already obtained earlier via a call to ''/auth/login''.'
  version: v4.144.0 - 39b4253
  contact: {}
servers:
- url: https://neutron.opendock.com
  description: Production Server
- url: https://neutron.staging.opendock.com
  description: Staging Server
tags:
- name: YMS - Yard View
paths:
  /yard/view/spot-grid:
    get:
      operationId: YardViewController_getSpotGrid
      summary: Get lean spot grid data optimized for grid view rendering
      parameters:
      - name: warehouseId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpotGridResponseDto'
      tags:
      - YMS - Yard View
      security:
      - bearer: []
  /yard/view/waiting-assets:
    get:
      operationId: YardViewController_getWaitingAssets
      summary: Get asset visits and containers waiting for spot assignment
      parameters:
      - name: warehouseId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YardViewWaitingQueueResponseDto'
      tags:
      - YMS - Yard View
      security:
      - bearer: []
  /yard/view/list-rows:
    get:
      operationId: YardViewController_getListViewRows
      summary: Get flattened list view rows (one row per container or truckless visit)
      parameters:
      - name: warehouseId
        required: true
        in: query
        schema:
          type: string
      - name: includeWaiting
        required: false
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListViewResponseDto'
      tags:
      - YMS - Yard View
      security:
      - bearer: []
  /yard/view/spot-detail:
    get:
      operationId: YardViewController_getSpotDetail
      summary: 'Get full spot detail for drawer: spot, task, assignment, and when applicable…'
      parameters:
      - name: spotId
        required: true
        in: query
        schema:
          type: string
      - name: warehouseId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpotDetailResponseDto'
      tags:
      - YMS - Yard View
      security:
      - bearer: []
components:
  schemas:
    SpotGridAssignmentDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        spotId:
          type: string
          format: uuid
        createDateTime:
          type: string
          format: date-time
        lastChangedDateTime:
          type: string
          format: date-time
        observation:
          type:
          - object
          - 'null'
        assetVisitId:
          type:
          - object
          - 'null'
          format: uuid
        assetContainerId:
          type:
          - object
          - 'null'
          format: uuid
        assetVisit:
          description: Populated when the assignment targets an asset visit (truck / attached).
          allOf:
          - $ref: '#/components/schemas/SpotGridAssetVisitDto'
        assetContainer:
          description: Populated when the assignment targets a standalone container only.
          allOf:
          - $ref: '#/components/schemas/SpotGridAssetContainerDto'
      required:
      - id
      - spotId
      - createDateTime
      - lastChangedDateTime
      - observation
      - assetVisitId
      - assetContainerId
      - assetVisit
      - assetContainer
    SpotGridAssetVisitDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        orgId:
          type: string
          format: uuid
        warehouseId:
          type: string
          format: uuid
        visitType:
          type:
          - string
          - 'null'
          enum:
          - LiveUnload
          - LiveLoad
          - Live
          - Drop
          - PickUp
          - DropHook
          - Unknown
        company:
          allOf:
          - $ref: '#/components/schemas/YardViewCompanyRefDto'
        companyHint:
          type:
          - object
          - 'null'
        phone:
          type:
          - object
          - 'null'
        isPlanned:
          type: boolean
        licensePlate:
          type:
          - object
          - 'null'
        dotNumber:
          type:
          - object
          - 'null'
        companyId:
          type:
          - object
          - 'null'
          format: uuid
        checkInAcknowledged:
          type:
          - object
          - 'null'
        createDateTime:
          type: string
          format: date-time
        lastChangedDateTime:
          type: string
          format: date-time
        appointment:
          allOf:
          - $ref: '#/components/schemas/YardViewAppointmentRefDto'
        assetContainers:
          type: array
          items:
            $ref: '#/components/schemas/SpotGridAssetContainerDto'
        assetVisitEvents:
          type: array
          items:
            $ref: '#/components/schemas/SpotGridAssetVisitEventDto'
      required:
      - id
      - orgId
      - warehouseId
      - visitType
      - company
      - companyHint
      - phone
      - isPlanned
      - licensePlate
      - dotNumber
      - companyId
      - checkInAcknowledged
      - createDateTime
      - lastChangedDateTime
      - appointment
      - assetContainers
      - assetVisitEvents
    ListViewAssetVisitDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        company:
          allOf:
          - $ref: '#/components/schemas/YardViewCompanyRefDto'
        phone:
          type:
          - object
          - 'null'
        visitType:
          type:
          - string
          - 'null'
          enum:
          - LiveUnload
          - LiveLoad
          - Live
          - Drop
          - PickUp
          - DropHook
          - Unknown
        arrivedAt:
          type:
          - string
          - 'null'
          format: date-time
        createDateTime:
          type:
          - string
          - 'null'
          format: date-time
        isPlanned:
          type: boolean
      required:
      - id
      - company
      - phone
      - visitType
      - arrivedAt
      - createDateTime
      - isPlanned
    SpotGridAreaDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        warehouseId:
          type: string
          format: uuid
          description: Warehouse this spot area belongs to (same for all areas in this response).
        orgId:
          type: string
          format: uuid
          description: Organization scope for this spot area.
        spots:
          type: array
          items:
            $ref: '#/components/schemas/SpotGridItemDto'
      required:
      - id
      - name
      - warehouseId
      - orgId
      - spots
    ListViewAppointmentRefDto:
      type: object
      properties:
        id:
          type:
          - object
          - 'null'
          format: uuid
        refNumber:
          type:
          - object
          - 'null'
        confirmationNumber:
          type:
          - object
          - 'null'
      required:
      - id
      - refNumber
      - confirmationNumber
    SpotGridResponseDto:
      type: object
      properties:
        areas:
          type: array
          items:
            $ref: '#/components/schemas/SpotGridAreaDto'
      required:
      - areas
    ListViewAppointmentDto:
      type: object
      properties:
        id:
          type:
          - object
          - 'null'
          format: uuid
        identifier:
          type:
          - object
          - 'null'
        refNumber:
          type:
          - object
          - 'null'
        confirmationNumber:
          type:
          - object
          - 'null'
        isPlanned:
          type: boolean
      required:
      - id
      - identifier
      - refNumber
      - confirmationNumber
      - isPlanned
    YardViewOpenMoveTaskChildRefsDto:
      type: object
      properties:
        originSpot:
          $ref: '#/components/schemas/YardViewOpenMoveTaskChildEntityRefDto'
        destinationSpot:
          $ref: '#/components/schemas/YardViewOpenMoveTaskChildEntityRefDto'
        assetContainer:
          $ref: '#/components/schemas/YardViewOpenMoveTaskChildEntityRefDto'
    SpotGridAssetVisitEventDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        eventType:
          type: string
          enum:
          - NotArrived
          - Arrived
          - Docked
          - Departed
          - Canceled
          - Attached
          - Detached
          - Appointment Linked
          - Appointment Unlinked
          - RejectedByCheckin
          - RejectedByWarehouse
        createDateTime:
          type: string
          format: date-time
        createdBy:
          type:
          - object
          - 'null'
          format: uuid
        assetVisitId:
          type: string
          format: uuid
        assetContainerId:
          type:
          - object
          - 'null'
          format: uuid
      required:
      - id
      - eventType
      - createDateTime
      - createdBy
      - assetVisitId
      - assetContainerId
    SpotGridContainerAppointmentRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        user:
          $ref: '#/components/schemas/SpotGridContainerAppointmentUserDto'
      required:
      - id
    SpotGridAssetContainerDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type:
          - string
          - 'null'
          enum:
          - Trailer
          - Container
          - Oversized
          - Chassis
          - Reefer
          - Other
        state:
          type:
          - string
          - 'null'
          enum:
          - Full
          - Empty
          - Partially Loaded
        code:
          type: string
        orgId:
          type: string
          format: uuid
        warehouseId:
          type: string
          format: uuid
        assetVisitId:
          type:
          - object
          - 'null'
          format: uuid
        pickupAppointmentId:
          type:
          - object
          - 'null'
          format: uuid
        dropAppointmentId:
          type:
          - object
          - 'null'
          format: uuid
        company:
          allOf:
          - $ref: '#/components/schemas/YardViewCompanyRefDto'
        pickupAppointment:
          allOf:
          - $ref: '#/components/schemas/SpotGridContainerAppointmentRefDto'
        dropAppointment:
          allOf:
          - $ref: '#/components/schemas/SpotGridContainerAppointmentRefDto'
        assetContainerEvents:
          type: array
          items:
            $ref: '#/components/schemas/SpotGridAssetContainerEventDto'
        createDateTime:
          type:
          - string
          - 'null'
          format: date-time
        lastChangedDateTime:
          type:
          - string
          - 'null'
          format: date-time
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
      required:
      - id
      - type
      - state
      - code
      - orgId
      - warehouseId
      - assetVisitId
      - pickupAppointmentId
      - dropAppointmentId
      - company
      - pickupAppointment
      - dropAppointment
      - assetContainerEvents
      - createDateTime
      - lastChangedDateTime
      - tags
    SpotGridContainerAppointmentUserDto:
      type: object
      properties:
        company:
          $ref: '#/components/schemas/YardViewCompanyRefDto'
    YardViewSpotReserveRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        isActive:
          type: boolean
        entityName:
          type:
          - object
          - 'null'
          description: SpotReserveEntityEnum
        objectId:
          type:
          - object
          - 'null'
          format: uuid
        validUntil:
          type:
          - string
          - 'null'
          format: date-time
        createDateTime:
          type: string
          format: date-time
        lastChangedDateTime:
          type: string
          format: date-time
      required:
      - id
      - isActive
      - entityName
      - objectId
      - validUntil
      - createDateTime
      - lastChangedDateTime
    SpotDetailResponseDto:
      type: object
      properties:
        spot:
          type: object
          description: 'Full spot for drawer: core fields, spotReserves, spotAssignments[0] with visit/container'
        openMoveTask:
          description: Active move task for this spot when present (same shape as spot-grid / list-rows)
          allOf:
          - $ref: '#/components/schemas/YardViewOpenMoveTaskRefDto'
        arrivalContainers:
          description: When assignment has assetVisit without appointment (unplanned)
          type: array
          items:
            $ref: '#/components/schemas/YardViewSpotDetailAssetContainerItemDto'
        containersWithSamePickupAppointment:
          description: Containers with same pickup appointment as the visit
          type: array
          items:
            $ref: '#/components/schemas/YardViewSpotDetailAssetContainerItemDto'
        containersWithSameDropAppointment:
          description: Containers with same drop appointment as the visit
          type: array
          items:
            $ref: '#/components/schemas/YardViewSpotDetailAssetContainerItemDto'
      required:
      - spot
    ListViewAssetContainerEventDto:
      type: object
      properties:
        createDateTime:
          type:
          - string
          - 'null'
          format: date-time
        eventType:
          type:
          - string
          - 'null'
          enum:
          - Arrived
          - Loading
          - Loading Complete
          - Unloading
          - Unloading Complete
          - Ready for Pickup
          - Departed
          - Inoperable
          - Missing
        assetVisitId:
          type:
          - object
          - 'null'
          format: uuid
        assetVisit:
          allOf:
          - $ref: '#/components/schemas/ListViewAssetVisitCarrierRefDto'
      required:
      - createDateTime
      - eventType
      - assetVisitId
      - assetVisit
    YardViewSpotRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
          description: Spot code (display / yard label)
        spotAreaId:
          type: string
          format: uuid
          description: Owning spot area id for presenter hydration
      required:
      - id
      - code
    SpotGridItemDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        code:
          type: string
        type:
          type: string
          description: SpotType enum
        isActive:
          type: boolean
          description: Spot open vs closed. With a container on `spotAssignments[0]`, UI can derive move-task lock (see @nova/core isSpotLocked).
        spotAreaId:
          type: string
          format: uuid
          description: Parent spot area id
        createDateTime:
          type: string
          format: date-time
        lastChangedDateTime:
          type: string
          format: date-time
        spotReserves:
          description: 'Active reserves for this spot (BFF loads active only). UI: isSpotReserved = spotReserves.length > 0.'
          type: array
          items:
            $ref: '#/components/schemas/YardViewSpotReserveRefDto'
        spotAssignments:
          description: At most one assignment for the grid cell; empty when unassigned.
          type: array
          items:
            $ref: '#/components/schemas/SpotGridAssignmentDto'
        openMoveTask:
          description: Active move task when tied to this spot (reserve or assigned container).
          allOf:
          - $ref: '#/components/schemas/YardViewOpenMoveTaskRefDto'
      required:
      - id
      - code
      - type
      - isActive
      - spotAreaId
      - createDateTime
      - lastChangedDateTime
      - spotReserves
      - spotAssignments
      - openMoveTask
    YardViewAppointmentRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: object
          description: Appointment status
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        refNumber:
          type: object
        refNumbers:
          description: All reference numbers on the appointment
          type: array
          items:
            type: string
        confirmationNumber:
          type: object
        dock:
          $ref: '#/components/schemas/YardViewDockRefDto'
        loadType:
          $ref: '#/components/schemas/YardViewLoadTypeRefDto'
      required:
      - id
      - refNumbers
    ListViewAppointmentPresenterDto:
      type: object
      properties:
        id:
          type:
          - object
          - 'null'
          format: uuid
        userId:
          type:
          - object
          - 'null'
          format: uuid
        user:
          allOf:
          - $ref: '#/components/schemas/ListViewUserRefDto'
        refNumber:
          type:
          - object
          - 'null'
        confirmationNumber:
          type:
          - object
          - 'null'
      required:
      - id
      - userId
      - user
      - refNumber
      - confirmationNumber
    ListViewResponseDto:
      type: object
      properties:
        rows:
          type: array
          items:
            $ref: '#/components/schemas/ListViewRowDto'
      required:
      - rows
    ListViewUserRefDto:
      type: object
      properties:
        id:
          type:
          - object
          - 'null'
          format: uuid
        companyId:
          type:
          - object
          - 'null'
          format: uuid
        company:
          allOf:
          - $ref: '#/components/schemas/YardViewCompanyRefDto'
      required:
      - id
      - companyId
      - company
    SpotGridAssetContainerEventDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        eventType:
          type: string
          enum:
          - Arrived
          - Loading
          - Loading Complete
          - Unloading
          - Unloading Complete
          - Ready for Pickup
          - Departed
          - Inoperable
          - Missing
        createDateTime:
          type: string
          format: date-time
        createdBy:
          type:
          - object
          - 'null'
          format: uuid
        assetVisitId:
          type:
          - object
          - 'null'
          format: uuid
        assetContainerId:
          type: string
          format: uuid
      required:
      - id
      - eventType
      - createDateTime
      - createdBy
      - assetVisitId
      - assetContainerId
    YardViewOpenMoveTaskRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        refNum:
          type: string
          description: 'Display ref number (e.g. Tasks #123)'
        role:
          type: string
          enum:
          - origin
          - destination
          description: 'origin: move task tied to assigned container on this spot; destination: task tied via spot reserve on this spot'
        child:
          description: Child move-task refs used by clients that resolve spot/container links through nested child ids.
          allOf:
          - $ref: '#/components/schemas/YardViewOpenMoveTaskChildRefsDto'
      required:
      - id
      - refNum
      - role
    YardViewDockRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
      - id
      - name
    ListViewRowDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Container ID, or visit ID when visit has no containers
        isWaiting:
          type: boolean
          description: Whether this asset is waiting for assignment vs parked on a spot
        spot:
          allOf:
          - $ref: '#/components/schemas/YardViewSpotRefDto'
        spotArea:
          allOf:
          - $ref: '#/components/schemas/YardViewSpotAreaRefDto'
        spotReserves:
          description: Active spot reserves when row is parked on a spot (empty when waiting). Same shape as spot-grid; derive reserved as length > 0.
          type: array
          items:
            $ref: '#/components/schemas/YardViewSpotReserveRefDto'
        assetArrivedAt:
          type:
          - string
          - 'null'
          format: date-time
        assetContainer:
          allOf:
          - $ref: '#/components/schemas/ListViewAssetContainerDto'
        assetVisit:
          allOf:
          - $ref: '#/components/schemas/ListViewAssetVisitDto'
        appointment:
          allOf:
          - $ref: '#/components/schemas/ListViewAppointmentDto'
        dropAppointmentCompany:
          description: Company that dropped this container
          allOf:
          - $ref: '#/components/schemas/YardViewCompanyRefDto'
        pickupAppointmentCompany:
          description: Company scheduled to pick up this container
          allOf:
          - $ref: '#/components/schemas/YardViewCompanyRefDto'
        dropoffAppointment:
          allOf:
          - $ref: '#/components/schemas/ListViewAppointmentRefDto'
        pickupAppointment:
          allOf:
          - $ref: '#/components/schemas/ListViewAppointmentRefDto'
        openMoveTask:
          allOf:
          - $ref: '#/components/schemas/YardViewOpenMoveTaskRefDto'
        customFormData:
          description: Custom form data entries for this container
          type: array
          items:
            $ref: '#/components/schemas/CustomFormDataItemDto'
      required:
      - id
      - isWaiting
      - spot
      - spotArea
      - spotReserves
      - assetArrivedAt
      - assetContainer
      - assetVisit
      - appointment
      - dropAppointmentCompany
      - pickupAppointmentCompany
      - dropoffAppointment
      - pickupAppointment
      - openMoveTask
      - customFormData
    CustomFormDataItemDto:
      type: object
      properties:
        objectId:
          type: string
          format: uuid
        formFieldId:
          type: object
          format: uuid
        label:
          type: string
        value:
          type: object
        type:
          type: string
          enum:
          - str
          - bigstr
          - date
          - bool
          - doc
          - multidoc
          - int
          - email
          - phone
          - dropdown
          - dropdownmultiselect
          - combobox
          - timestamp
          - action
      required:
      - objectId
      - label
      - type
    ListViewAssetContainerDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        code:
          type:
          - object
          - 'null'
          description: Container code / trailer number
        type:
          type:
          - string
          - 'null'
          enum:
          - Trailer
          - Container
          - Oversized
          - Chassis
          - Reefer
          - Other
        state:
          type:
          - string
          - 'null'
          enum:
          - Full
          - Empty
          - Partially Loaded
        status:
          type:
          - string
          - 'null'
          enum:
          - Arrived
          - Loading
          - Loading Complete
          - Unloading
          - Unloading Complete
          - Ready for Pickup
          - Departed
          - Inoperable
          - Missing
        company:
          description: Container owner
          allOf:
          - $ref: '#/components/schemas/YardViewCompanyRefDto'
        createDateTime:
          type:
          - string
          - 'null'
          format: date-time
        assetContainerEvents:
          type: array
          items:
            $ref: '#/components/schemas/ListViewAssetContainerEventDto'
        dropAppointment:
          allOf:
          - $ref: '#/components/schemas/ListViewAppointmentPresenterDto'
        pickupAppointment:
          allOf:
          - $ref: '#/components/schemas/ListViewAppointmentPresenterDto'
        notes:
          type:
          - object
          - 'null'
          description: Free-form notes on the asset container
      required:
      - id
      - code
      - type
      - state
      - status
      - company
      - createDateTime
      - assetContainerEvents
      - dropAppointment
      - pickupAppointment
      - notes
    YardViewSpotAreaRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
      - id
      - name
    YardViewCompanyRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
      required:
      - id
      - name
    ListViewAssetVisitCarrierRefDto:
      type: object
      properties:
        id:
          type:
          - object
          - 'null'
          format: uuid
        companyId:
          type:
          - object
          - 'null'
          format: uuid
        company:
          allOf:
          - $ref: '#/components/schemas/YardViewCompanyRefDto'
      required:
      - id
      - companyId
      - company
    YardViewLoadTypeRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        direction:
          type: string
          enum:
          - Inbound
          - Outbound
          - Inbound/Outbound
      required:
      - id
      - name
      - direction
    YardViewOpenMoveTaskChildEntityRefDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
      required:
      - id
    YardViewWaitingQueueResponseDto:
      type: object
      properties:
        assets:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/YardViewWaitingVisitRowDto'
            - $ref: '#/components/schemas/YardViewWaitingContainerRowDto'
            discriminator:
              propertyName: kind
      required:
      - assets
    YardViewSpotDetailAssetContainerItemDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        code:
          type: object
        type:
          type: string
          enum:
          - Trailer
          - Container
          - Oversized
          - Chassis
          - Reefer
          - Other
        pickupAppointmentId:
          type: object
          format: uuid
        dropAppointmentId:
          type: object
          format: uuid
      required:
      - id
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http