Modify a Yard Camera

PATCH /api/camera/yard-cameras/{yardCameraId}

Modifies an assigned camera

Path parameters

yardCameraId integer(int64) Required

Yard Camera ID

application/json

Body

integration_id integer(int64) Required

Camera Provider ID from /integrations endpoint
integration_camera_id string Required

Identifier of the camera in the provider's context
yard_id integer(int64) Required

Assigned Yard ID
direction Required

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.

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

PATCH /api/camera/yard-cameras/{yardCameraId}

curl \
 -X PATCH https://api-dev.gatego.io/api/camera/yard-cameras/{yardCameraId} \
 -H "Content-Type: application/json" \
 -d '{"integration_id":42,"integration_camera_id":"string","yard_id":4,"direction":"IN","attachment_types":["TRAILER_LEFT_PHOTO"]}'

Request examples

{
  "integration_id": 42,
  "integration_camera_id": "string",
  "yard_id": 4,
  "direction": "IN",
  "attachment_types": [
    "TRAILER_LEFT_PHOTO"
  ]
}

Response examples (200)

{
  "id": 42,
  "yard_id": 42,
  "attachment_types": [
    "TRAILER_LEFT_PHOTO"
  ],
  "integration_camera": {
    "integration_id": 42,
    "integration_camera_id": "string",
    "name": "string",
    "camera_params": {
      "thumbnail_url": {
        "use_proxy": true,
        "base": "https://api.verkada.com/cameras/v1/footage/thumbnails",
        "method": "GET",
        "request_params": {
          "resolution": "low-res"
        },
        "headers": {
          "x-api-key": "da12cb332"
        }
      },
      "thumbnail_from_stream_url": {
        "use_proxy": true,
        "base": "https://api.verkada.com/cameras/v1/footage/thumbnails",
        "method": "GET",
        "request_params": {
          "resolution": "low-res"
        },
        "headers": {
          "x-api-key": "da12cb332"
        }
      }
    }
  }
}