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

Status Status Meaning Relevance
14 Collected - The Load has been collected Indicates that the Load 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.
24 Complete - The truck has completed the delivery Indicates that the Load has been delivered and signed off. Each vehicle then contains the pickup plus the delivery data including damage and signatures.

 

Status Updates

Status Status Meaning Relevance
28 Allocated - The load has been allocated to a Carrier or contractor Indicates that a Carrier has been dispatched the load
2 Assigned - The Load has been assigned to a driver Indicates that the Load is about to start
12 OnWayToCollect - The truck is onway to pickup the vehicles Estimated time of Pickup
13 AtCollection - The Truck has arrived at the pickup location On site and loading vehicles
16 OnWayToDeliver - The Truck is onway to deliver the vehicles Estimated time to delivery from the driver, Gate Out code from Pickup location
18 AtDelivery - The Truck has arrived at the delivery location On site and delivering vehicles

 

Full Job Class Documentation

 

 

Weight: 
-5