Send the generated gatepass to the preferred notification channel of the driver associated to the given precheck
POST
/api/yardmovement-precheck/{id}/gatepass/send
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)
Path parameters
-
id integer(int64) Required
id
Query parameters
-
yard_id
-
generateGatepassIfNotExists boolean
If true, a Gatepass Code will be generated if the precheck doesn't have one already
Responses
-
• 200
Gatepass successfully sent to the channel provider. It does not mean that the driver has received the gatepass
-
• 201
Created
-
• 400
Error while sending the gatepass to the channel provider. The message has not been sent. Eg. the driver does not have a phone number or email address
-
• 401
Unauthorized
-
• 403
Forbidden
-
• 404
Not Found
-
• 500
Unexpected server error.
POST /api/yardmovement-precheck/{id}/gatepass/send
curl \
-X POST https://api-dev.gatego.io:443/api/yardmovement-precheck/{id}/gatepass/send \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"driver":{"notification_email":"string","notification_phone":"string","notification_preference_channel":"EMAIL"}}'
Request example
# Headers
# Payload
{
"driver": {
"notification_email": "string",
"notification_phone": "string",
"notification_preference_channel": "EMAIL"
}
}
Response examples (200)
{
"current_status": "UNKNOWN",
"delivery_id": "string"
}