gatego API documentation

Retrieve a Precheck by identifier

GET /api/yardmovement-precheck/{id}

This endpoint will return the Precheck even if it has been already checked

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Path parameters

id integer(int64) Required

id

Query parameters

Optional yard identifier to filter prechecks to a given yard. When present, the requested precheck by id will be returned only if it is in the given yard. Please note that Guards will be automatically restricted to see Prechecks in their own Yard integer(int64)

yard_id

Responses

• 200

OK
Hide response attributes Show response attributes object
- attachment_ids array[integer(int64)]
- attachment_picture_ids array[integer(int64)]
- chassis_number string
- chassis_size string
- checked boolean
  
  True if this precheck was used to componse a final checkin or checkout
- comments string
- created_at string(date-time)
- created_by string
- destination string
- direction string
  
  Values are IN or OUT.
- driver object
  
  The driver associated to this precheck
  
  Hide driver attributes Show driver attributes
  
  id integer(int64)
  
  license string
  
  license_expiration string(date-time)
  
  license_picture_id integer(int64)
  
  name string
  
  notification_email string
  
  notification_phone string
  
  notification_preference_channel string
  
  Values are EMAIL, SMS, or WHATSAPP.
  
  photo_id integer(int64)
- driver_id integer(int64)
- driver_license string
- driver_license_picture_id integer(int64)
- driver_name string
- driver_notification_email string
- driver_notification_phone string
- driver_notification_preference_channel string
  
  Values are EMAIL, SMS, or WHATSAPP.
- driver_photo_id integer(int64)
- eta_timestamp string(date-time)
  
  Expected time of arrival of the truck/trailer defined in this Precheck
- extra_trailers array[object]
  
  Hide extra_trailers attributes Show extra_trailers attributes
  
  carrier_id integer(int64)
  
  carrier_name string
  
  client string
  
  destination string
  
  id integer(int64)
  
  inside_picture_id integer(int64)
  
  left_image_id integer(int64)
  
  load string
  
  movement_id integer(int64)
  
  movement_trailer_number string
  
  no_seal boolean
  
  number string
  
  other_carrier string
  
  priority boolean
  
  purpose string
  
  rear_picture_id integer(int64)
  
  right_image_id integer(int64)
  
  seal string
  
  seal_picture_ids array[integer(int64)]
  
  shipment_id string
  
  sku string
  
  status string
  
  Values are EMPTY, LOADED, or NO_TRAILER.
  
  status_desc string
  
  tags array[object]
  
  Hide tags attributes Show tags attributes
  
  color string
  
  created_at string(date-time)
  
  id integer(int64)
  
  last_modified_at string(date-time)
  
  name string
  
  trailer_location object
  
  Hide trailer_location attributes Show trailer_location attributes
  
  level string
  
  row string
  
  values array[string]
  
  zone string
  
  trailer_out_movement_id integer(int64)
  
  trailer_stay_seconds integer(int64)
  
  type string
- gatepass_code string
  
  The gatepass code generated for this precheck, if any
- id integer(int64)
  
  The precheck identifier
- inside_trailer_picture_id integer(int64)
- inspections array[object]
  
  Hide inspections attributes Show inspections attributes
  
  attachments array[object]
  
  An image or any binary attachment associated to a particular inspection. Even if the inspection json format is free for the caller, and it could include also attachmentIds the advantage of using separated inspection attachments is that they can be made publishable by the system or be serialized to be delivered via any notification system.
  
  The inspection attachment can have an optional name to be retrieved later by that name. Or it can also include a bag of attachments without any name.
  
  Hide attachments attributes Show attachments attributes
  
  attachment_id integer(int64) Required
  
  Reference to the identifier of an existing attachment.
  
  name string
  
  Optional name to give it a tag or meaning to the attachment, which also allows to retrieve the attachment by name
  
  created_at string(date-time)
  
  id integer(int64)
  
  inspection_content object
  
  inspection_type string
  
  last_modified_at string(date-time)
  
  trailer_id integer(int64)
  
  trailer_number string
  
  truck_id integer(int64)
  
  truck_number string
  
  yard_movement_id integer(int64)
- last_modified_at string(date-time)
- last_modified_by string
- left_trailer_image_id integer(int64)
- load string
- movement_driver_name string
- movement_trailer_number string
- movement_truck_number string
- no_seal boolean
- other_trailer_carrier string
- other_truck_carrier string
- pin integer(int64)
- pin_valid_until string(date-time)
- purpose string
- rear_trailer_picture_id integer(int64)
- right_trailer_image_id integer(int64)
- seal string
- seal_picture_ids array[integer(int64)]
- shipment_id string
- sku string
- spare_tire_truck_photo_id integer(int64)
- status string
- trailer string
- trailer_carrier_id integer(int64)
- trailer_carrier_name string
- trailer_client string
- trailer_id integer(int64)
- trailer_inspection object
  
  Hide trailer_inspection attributes Show trailer_inspection attributes
  
  attachments array[object]
  
  An image or any binary attachment associated to a particular inspection. Even if the inspection json format is free for the caller, and it could include also attachmentIds the advantage of using separated inspection attachments is that they can be made publishable by the system or be serialized to be delivered via any notification system.
  
  The inspection attachment can have an optional name to be retrieved later by that name. Or it can also include a bag of attachments without any name.
  
  Hide attachments attributes Show attachments attributes
  
  attachment_id integer(int64) Required
  
  Reference to the identifier of an existing attachment.
  
  name string
  
  Optional name to give it a tag or meaning to the attachment, which also allows to retrieve the attachment by name
  
  created_at string(date-time)
  
  id integer(int64)
  
  inspection_content object
  
  inspection_type string
  
  last_modified_at string(date-time)
  
  trailer_id integer(int64)
  
  trailer_number string
  
  truck_id integer(int64)
  
  truck_number string
  
  yard_movement_id integer(int64)
- trailer_location object
  
  Hide trailer_location attributes Show trailer_location attributes
  
  level string
  
  row string
  
  values array[string]
  
  zone string
- trailer_number string
- trailer_number_inference string
- trailer_priority boolean
- trailer_tags array[object]
  
  Hide trailer_tags attributes Show trailer_tags attributes
  
  associated_at string(date-time)
  
  color string
  
  created_at string(date-time)
  
  id integer(int64)
  
  last_modified_at string(date-time)
  
  name string
- trailer_type string
- truck_carrier_id integer(int64)
- truck_carrier_name string
- truck_fuel_type string
  
  Values are CNG, DIESEL, ELECTRIC, or HYDROGEN.
- truck_id integer(int64)
- truck_image_id integer(int64)
- truck_inspection object
  
  Hide truck_inspection attributes Show truck_inspection attributes
  
  attachments array[object]
  
  An image or any binary attachment associated to a particular inspection. Even if the inspection json format is free for the caller, and it could include also attachmentIds the advantage of using separated inspection attachments is that they can be made publishable by the system or be serialized to be delivered via any notification system.
  
  The inspection attachment can have an optional name to be retrieved later by that name. Or it can also include a bag of attachments without any name.
  
  Hide attachments attributes Show attachments attributes
  
  attachment_id integer(int64) Required
  
  Reference to the identifier of an existing attachment.
  
  name string
  
  Optional name to give it a tag or meaning to the attachment, which also allows to retrieve the attachment by name
  
  created_at string(date-time)
  
  id integer(int64)
  
  inspection_content object
  
  inspection_type string
  
  last_modified_at string(date-time)
  
  trailer_id integer(int64)
  
  trailer_number string
  
  truck_id integer(int64)
  
  truck_number string
  
  yard_movement_id integer(int64)
- truck_left_photo_id integer(int64)
- truck_number string
- truck_right_photo_id integer(int64)
- truck_type string
  
  Values are BOX, PICKUP, or SEMI.
- vehicle_image_id integer(int64)
- visit_type string
- yard_id integer(int64)
- yard_movement_id integer(int64)
  
  The yardmovement identifier of the checkin or checkout created from this Precheck
- yard_name string
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

GET /api/yardmovement-precheck/{id}

curl \
 -X GET https://api-dev.gatego.io:443/api/yardmovement-precheck/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "attachment_ids": [
    42
  ],
  "attachment_picture_ids": [
    42
  ],
  "chassis_number": "string",
  "chassis_size": "string",
  "checked": false,
  "comments": "string",
  "created_at": "2023-05-04T09:42:00+00:00",
  "created_by": "string",
  "destination": "string",
  "direction": "IN",
  "driver": {
    "id": 42,
    "license": "string",
    "license_expiration": "2023-05-04T09:42:00+00:00",
    "license_picture_id": 42,
    "name": "string",
    "notification_email": "string",
    "notification_phone": "string",
    "notification_preference_channel": "EMAIL",
    "photo_id": 42
  },
  "driver_id": 42,
  "driver_license": "string",
  "driver_license_picture_id": 42,
  "driver_name": "string",
  "driver_notification_email": "string",
  "driver_notification_phone": "string",
  "driver_notification_preference_channel": "EMAIL",
  "driver_photo_id": 42,
  "eta_timestamp": "2023-05-04T09:42:00+00:00",
  "extra_trailers": [
    {
      "carrier_id": 42,
      "carrier_name": "string",
      "client": "string",
      "destination": "string",
      "id": 42,
      "inside_picture_id": 42,
      "left_image_id": 42,
      "load": "string",
      "movement_id": 42,
      "movement_trailer_number": "string",
      "no_seal": true,
      "number": "string",
      "other_carrier": "string",
      "priority": true,
      "purpose": "string",
      "rear_picture_id": 42,
      "right_image_id": 42,
      "seal": "string",
      "seal_picture_ids": [
        42
      ],
      "shipment_id": "string",
      "sku": "string",
      "status": "EMPTY",
      "status_desc": "string",
      "tags": [
        {
          "color": "string",
          "created_at": "2023-05-04T09:42:00+00:00",
          "id": 42,
          "last_modified_at": "2023-05-04T09:42:00+00:00",
          "name": "string"
        }
      ],
      "trailer_location": {
        "level": "string",
        "row": "string",
        "values": [
          "string"
        ],
        "zone": "string"
      },
      "trailer_out_movement_id": 42,
      "trailer_stay_seconds": 42,
      "type": "string"
    }
  ],
  "gatepass_code": "string",
  "id": 42,
  "inside_trailer_picture_id": 42,
  "inspections": [
    {
      "attachments": [
        {
          "attachment_id": 42,
          "name": "string"
        }
      ],
      "created_at": "2023-05-04T09:42:00+00:00",
      "id": 42,
      "inspection_content": {},
      "inspection_type": "string",
      "last_modified_at": "2023-05-04T09:42:00+00:00",
      "trailer_id": 42,
      "trailer_number": "string",
      "truck_id": 42,
      "truck_number": "string",
      "yard_movement_id": 42
    }
  ],
  "last_modified_at": "2023-05-04T09:42:00+00:00",
  "last_modified_by": "string",
  "left_trailer_image_id": 42,
  "load": "string",
  "movement_driver_name": "string",
  "movement_trailer_number": "string",
  "movement_truck_number": "string",
  "no_seal": true,
  "other_trailer_carrier": "string",
  "other_truck_carrier": "string",
  "pin": 42,
  "pin_valid_until": "2023-05-04T09:42:00+00:00",
  "purpose": "string",
  "rear_trailer_picture_id": 42,
  "right_trailer_image_id": 42,
  "seal": "string",
  "seal_picture_ids": [
    42
  ],
  "shipment_id": "string",
  "sku": "string",
  "spare_tire_truck_photo_id": 42,
  "status": "string",
  "trailer": "string",
  "trailer_carrier_id": 42,
  "trailer_carrier_name": "string",
  "trailer_client": "string",
  "trailer_id": 42,
  "trailer_inspection": {
    "attachments": [
      {
        "attachment_id": 42,
        "name": "string"
      }
    ],
    "created_at": "2023-05-04T09:42:00+00:00",
    "id": 42,
    "inspection_content": {},
    "inspection_type": "string",
    "last_modified_at": "2023-05-04T09:42:00+00:00",
    "trailer_id": 42,
    "trailer_number": "string",
    "truck_id": 42,
    "truck_number": "string",
    "yard_movement_id": 42
  },
  "trailer_location": {
    "level": "string",
    "row": "string",
    "values": [
      "string"
    ],
    "zone": "string"
  },
  "trailer_number": "string",
  "trailer_number_inference": "string",
  "trailer_priority": true,
  "trailer_tags": [
    {
      "associated_at": "2023-05-04T09:42:00+00:00",
      "color": "string",
      "created_at": "2023-05-04T09:42:00+00:00",
      "id": 42,
      "last_modified_at": "2023-05-04T09:42:00+00:00",
      "name": "string"
    }
  ],
  "trailer_type": "string",
  "truck_carrier_id": 42,
  "truck_carrier_name": "string",
  "truck_fuel_type": "CNG",
  "truck_id": 42,
  "truck_image_id": 42,
  "truck_inspection": {
    "attachments": [
      {
        "attachment_id": 42,
        "name": "string"
      }
    ],
    "created_at": "2023-05-04T09:42:00+00:00",
    "id": 42,
    "inspection_content": {},
    "inspection_type": "string",
    "last_modified_at": "2023-05-04T09:42:00+00:00",
    "trailer_id": 42,
    "trailer_number": "string",
    "truck_id": 42,
    "truck_number": "string",
    "yard_movement_id": 42
  },
  "truck_left_photo_id": 42,
  "truck_number": "string",
  "truck_right_photo_id": 42,
  "truck_type": "BOX",
  "vehicle_image_id": 42,
  "visit_type": "string",
  "yard_id": 42,
  "yard_movement_id": 42,
  "yard_name": "string"
}