Recipe 6 - Posting Status and Stop messages using CDX API

Recipe 6 - Posting Status and Stop messages using CDX API

Introduction

This recipe is for a Carrier who wants to POST CdxStatus and CdxStop messages to the rest open API as the vehicles are being pickedup and delivered. 

Sending Status and Stop messages - Open API POST

CdxStop

  • a CdxStop message should be sent as soon as the load data is updated by a truck/driver
  • see Swagger API definition
Post api/vind2/openapi/cdxstop
  application/json
  Basic Authentication
  /api/swagger-ui/#/47vind247openapi47cdxstop
  JSON Body Example

 

CdxStatus

  • a CdxStatus message should be sent as soon as the load data is updated by a truck/driver
  • see Swagger API definition
Post api/vind2/openapi/cdxstatus
  application/json
  Basic Authentication
  /api/swagger-ui/#/47vind247openapi47cdxstatus
  JSON Body Example

 

Suggested test tool Talend API Tester

 

Stop Updates

CdxDeliveryStatus Status Meaning Relevance
PickedUp The Vehicle has been collected Indicates that the vehicle has been loaded and signed off. Each vehicle then indicates if it has been collected, if there was any damage noted and who signed off the pickup.
Delivered The vehicle has completed the delivery Indicates that the vehicle has been delivered and signed off. Each vehicle then contains the pickup plus the delivery data including damage and signatures.
NotPickedUp The vehicle has not been Picked Up Indicates that the vehicle was not picked up, a reason should be included in the stop
NotDelivered The vehicle was not delivered Indicates that the vehicle was not delivered, a reason should be included in the stop

 

Status Updates

CdxDeliveryStatus Status Meaning Relevance
ReceivedByDriver

The Load has been assigned to a driver

Indicates that the Load is about to start
OnWayToPickup

The truck is onway to pickup the vehicle

Estimated time of Pickup
AtPickUp The Truck has arrived at the pickup location On site and loading vehicles
OnWayToDeliver The Truck is onway to deliver the vehicles Estimated time to delivery from the driver, Gate Out code from Pickup location
AtDelivery The Truck has arrived at the delivery location On site and delivering vehicles

 

 

 

 

Weight: 
-5