Query parameters

• attachmentTypes array[string]

  AttachmentType constant, or a list of AttachmentType constants separated by commas. This is an "or" list: Cameras that are associated with at least one of the attachment types in this list will be included in the response (as long as they match the other request parameters)

  Values are TRAILER_LEFT_PHOTO, TRAILER_RIGHT_PHOTO, TRAILER_INSIDE_PHOTO, TRAILER_SEAL_PHOTO, TRAILER_ISSUE_PHOTO, REAR_TRAILER_PHOTO, LICENSE_PLATE_PHOTO, WASH_OUT_SLIP_PHOTO, BILL_OF_LADING_PHOTO, TRUCK_PHOTO, TRUCK_ISSUE_PHOTO, TRUCK_CARRIER_INFO_PHOTO, TIRE_PHOTO, GUEST_VEHICLE_PHOTO, DRIVER_PHOTO, DRIVER_LICENSE_PHOTO, VISITOR_PERSON_PHOTO, or EXTRA_FILE.

• direction string

  Direction

  Values are IN or OUT.

• hasAttachmentType boolean

  When present: include only cameras that has been associated (when true), or has not been associated (when false) to at least one AttachmentType

• yard_id integer(int64)

  Yard ID

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)

    Camera ID

  • yard_id integer(int64)

    Assigned Yard ID

  • direction

    Assigned direction

  • attachment_types array[string]

    Assigned AttachmentType List

    Values are TRAILER_LEFT_PHOTO, TRAILER_RIGHT_PHOTO, TRAILER_INSIDE_PHOTO, TRAILER_SEAL_PHOTO, TRAILER_ISSUE_PHOTO, REAR_TRAILER_PHOTO, LICENSE_PLATE_PHOTO, WASH_OUT_SLIP_PHOTO, BILL_OF_LADING_PHOTO, TRUCK_PHOTO, TRUCK_ISSUE_PHOTO, TRUCK_CARRIER_INFO_PHOTO, TIRE_PHOTO, GUEST_VEHICLE_PHOTO, DRIVER_PHOTO, DRIVER_LICENSE_PHOTO, VISITOR_PERSON_PHOTO, or EXTRA_FILE.

  • integration_camera object

    TBC

    Additional properties are allowed.

    Hide integration_camera attributes Show integration_camera attributes object

    • integration_id integer(int64)

      Camera Provider ID from /integrations endpoint

    • integration_camera_id string

      Identifier of the camera in the provider's context

    • name string

      Name of the camera in the provider's context. It might not be available depending on the provider. Moreover it could be available only for some endpoints and not for others, depending on the provider

    • camera_params object

      Additional properties are allowed.

      Hide camera_params attributes Show camera_params attributes object

      • thumbnail_url object

        TBC

        Additional properties are allowed.

        Hide thumbnail_url attributes Show thumbnail_url attributes object

        • use_proxy boolean

          When true, that means the provider doesn't support direct access to their systems via frontend, but the thumbnail can be got using the backend endpoint /api/camera/proxied/.. which needs to be authenticated

        • base string

          Base URL

        • method string

          HTTP Method

        • request_params object

          Request Params

          Hide request_params attribute Show request_params attribute object

          • * string Additional properties
        • headers object

          Request Headers. Note that if headers are required this p

          Hide headers attribute Show headers attribute object

          • * string Additional properties
      • thumbnail_from_stream_url object

        TBC

        Additional properties are allowed.

        Hide thumbnail_from_stream_url attributes Show thumbnail_from_stream_url attributes object

        • use_proxy boolean

          When true, that means the provider doesn't support direct access to their systems via frontend, but the thumbnail can be got using the backend endpoint /api/camera/proxied/.. which needs to be authenticated

        • base string

          Base URL

        • method string

          HTTP Method

        • request_params object

          Request Params

          Hide request_params attribute Show request_params attribute object

          • * string Additional properties
        • headers object

          Request Headers. Note that if headers are required this p

          Hide headers attribute Show headers attribute object

          • * string Additional properties
• 401

  Not Authorized

• 403

  Not Allowed