Modified an existing movement precheck
Null values will be ignored and not modified
Headers
-
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)
Body
-
attachment_ids array[integer(int64)]
-
attachment_picture_ids array[integer(int64)]
-
bill_of_lading_photo_id integer(int64)
-
bol_number string
-
chassis_number string
-
chassis_size string
-
comments string
-
destination string
-
direction string
Values are
IN
orOUT
. -
driver_id integer(int64)
-
driver_license string
-
driver_license_expiration string(date-time)
-
driver_license_picture_id integer(int64)
-
driver_name string
-
driver_notification_email string
-
driver_notification_phone string
-
Values are
EMAIL
,SMS
, orWHATSAPP
. -
driver_photo_id integer(int64)
-
driver_safety_card_picture_id integer(int64)
-
eta_timestamp string(date-time)
Expected time of arrival
-
extra_trailers array[object]
-
inside_trailer_picture_id integer(int64)
-
left_trailer_image_id integer(int64)
-
license_plate_photo_id integer(int64)
-
load string
-
main_trailer object
-
movement_timestamp string(date-time)
-
no_seal boolean
-
other_trailer_carrier string
-
other_truck_carrier string
-
pager_number string
-
purpose string
-
rear_trailer_picture_id integer(int64)
-
right_trailer_image_id integer(int64)
-
safety_video_confirmation boolean
-
seal string
-
seal_picture_ids array[integer(int64)]
-
shipment_id string
-
sku string
-
spare_tire_truck_photo_id integer(int64)
-
status string
Values are
EMPTY
,LOADED
, orNO_TRAILER
. -
tanker_status string
-
trailer string
-
trailer_carrier_id integer(int64)
-
trailer_client string
-
trailer_custom_fields object
-
trailer_id integer(int64)
-
trailer_location object
-
trailer_priority boolean
-
trailer_type string
-
truck_carrier_id integer(int64)
-
truck_carrier_info_photo_id integer(int64)
-
truck_fuel_type string
Values are
CNG
,DIESEL
,ELECTRIC
, orHYDROGEN
. -
truck_id integer(int64)
-
truck_image_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
, orSEMI
. -
vehicle_image_id integer(int64)
-
visit_type string
Values are
TRACTOR
orVEHICLE
. -
visitor_badge_number string
-
visitor_company string
-
visitor_email string
-
visitor_host string
-
visitor_host_account_id integer(int64)
-
visitor_name string
-
visitor_person_photo_id integer(int64)
-
visitor_phone_number string
-
visitor_type string
Values are
PERSON
orVEHICLE
. -
wash_out_slip_photo_id integer(int64)
-
yard_id integer(int64)
Optional yard identifier if this precheck changed to another yard. A null value means "no change"
PATCH
/api/yardmovement-precheck/{id}
curl \
-X PATCH http://localhost:8080/api/yardmovement-precheck/{id} \
-H "Content-Type: application/json" \
-d '{"attachment_ids":[42],"attachment_picture_ids":[42],"bill_of_lading_photo_id":42,"bol_number":"string","chassis_number":"string","chassis_size":"string","comments":"string","destination":"string","direction":"IN","driver_id":42,"driver_license":"string","driver_license_expiration":"2024-05-04T09:42:00+00:00","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,"driver_safety_card_picture_id":42,"eta_timestamp":"2024-05-04T09:42:00+00:00","extra_trailers":[{"carrier_id":42,"client":"string","custom_fields":{"key":"string"},"id":42,"inside_picture_id":42,"left_image_id":42,"no_seal":true,"number":"string","number_inference":"string","other_carrier":"string","priority":true,"rear_picture_id":42,"right_image_id":42,"seal":"string","seal_picture_ids":[42],"status":"EMPTY","type":"string"}],"inside_trailer_picture_id":42,"left_trailer_image_id":42,"license_plate_photo_id":42,"load":"string","main_trailer":{"carrier_id":42,"client":"string","custom_fields":{"key":"string"},"id":42,"inside_picture_id":42,"left_image_id":42,"no_seal":true,"number":"string","number_inference":"string","other_carrier":"string","priority":true,"rear_picture_id":42,"right_image_id":42,"seal":"string","seal_picture_ids":[42],"status":"EMPTY","type":"string"},"movement_timestamp":"2024-05-04T09:42:00+00:00","no_seal":true,"other_trailer_carrier":"string","other_truck_carrier":"string","pager_number":"string","purpose":"string","rear_trailer_picture_id":42,"right_trailer_image_id":42,"safety_video_confirmation":true,"seal":"string","seal_picture_ids":[42],"shipment_id":"string","sku":"string","spare_tire_truck_photo_id":42,"status":"EMPTY","tanker_status":"string","trailer":"string","trailer_carrier_id":42,"trailer_client":"string","trailer_custom_fields":{"key":"string"},"trailer_id":42,"trailer_location":{"level":"string","row":"string","values":["string"],"zone":"string"},"trailer_priority":true,"trailer_type":"string","truck_carrier_id":42,"truck_carrier_info_photo_id":42,"truck_fuel_type":"CNG","truck_id":42,"truck_image_id":42,"truck_left_photo_id":42,"truck_number":"string","truck_right_photo_id":42,"truck_type":"BOX","vehicle_image_id":42,"visit_type":"TRACTOR","visitor_badge_number":"string","visitor_company":"string","visitor_email":"string","visitor_host":"string","visitor_host_account_id":42,"visitor_name":"string","visitor_person_photo_id":42,"visitor_phone_number":"string","visitor_type":"PERSON","wash_out_slip_photo_id":42,"yard_id":42}'
Request examples
# Headers
# Payload
{
"attachment_ids": [
42
],
"attachment_picture_ids": [
42
],
"bill_of_lading_photo_id": 42,
"bol_number": "string",
"chassis_number": "string",
"chassis_size": "string",
"comments": "string",
"destination": "string",
"direction": "IN",
"driver_id": 42,
"driver_license": "string",
"driver_license_expiration": "2024-05-04T09:42:00+00:00",
"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,
"driver_safety_card_picture_id": 42,
"eta_timestamp": "2024-05-04T09:42:00+00:00",
"extra_trailers": [
{
"carrier_id": 42,
"client": "string",
"custom_fields": {
"key": "string"
},
"id": 42,
"inside_picture_id": 42,
"left_image_id": 42,
"no_seal": true,
"number": "string",
"number_inference": "string",
"other_carrier": "string",
"priority": true,
"rear_picture_id": 42,
"right_image_id": 42,
"seal": "string",
"seal_picture_ids": [
42
],
"status": "EMPTY",
"type": "string"
}
],
"inside_trailer_picture_id": 42,
"left_trailer_image_id": 42,
"license_plate_photo_id": 42,
"load": "string",
"main_trailer": {
"carrier_id": 42,
"client": "string",
"custom_fields": {
"key": "string"
},
"id": 42,
"inside_picture_id": 42,
"left_image_id": 42,
"no_seal": true,
"number": "string",
"number_inference": "string",
"other_carrier": "string",
"priority": true,
"rear_picture_id": 42,
"right_image_id": 42,
"seal": "string",
"seal_picture_ids": [
42
],
"status": "EMPTY",
"type": "string"
},
"movement_timestamp": "2024-05-04T09:42:00+00:00",
"no_seal": true,
"other_trailer_carrier": "string",
"other_truck_carrier": "string",
"pager_number": "string",
"purpose": "string",
"rear_trailer_picture_id": 42,
"right_trailer_image_id": 42,
"safety_video_confirmation": true,
"seal": "string",
"seal_picture_ids": [
42
],
"shipment_id": "string",
"sku": "string",
"spare_tire_truck_photo_id": 42,
"status": "EMPTY",
"tanker_status": "string",
"trailer": "string",
"trailer_carrier_id": 42,
"trailer_client": "string",
"trailer_custom_fields": {
"key": "string"
},
"trailer_id": 42,
"trailer_location": {
"level": "string",
"row": "string",
"values": [
"string"
],
"zone": "string"
},
"trailer_priority": true,
"trailer_type": "string",
"truck_carrier_id": 42,
"truck_carrier_info_photo_id": 42,
"truck_fuel_type": "CNG",
"truck_id": 42,
"truck_image_id": 42,
"truck_left_photo_id": 42,
"truck_number": "string",
"truck_right_photo_id": 42,
"truck_type": "BOX",
"vehicle_image_id": 42,
"visit_type": "TRACTOR",
"visitor_badge_number": "string",
"visitor_company": "string",
"visitor_email": "string",
"visitor_host": "string",
"visitor_host_account_id": 42,
"visitor_name": "string",
"visitor_person_photo_id": 42,
"visitor_phone_number": "string",
"visitor_type": "PERSON",
"wash_out_slip_photo_id": 42,
"yard_id": 42
}
Response examples (200)
{
"checked": true,
"driver": {
"id": 42,
"license": "string",
"license_expiration": "2024-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,
"safety_card_picture_id": 42
},
"gatepass_code": "string",
"id": 42,
"yard_movement_id": 42
}