Skip to main content

Route itinerary

Send a route itinerary message with a routeId; if the routeId is known, some messages will be sent by the SDK

  • JOB_PROGRESS to follow the calculation progression, until it is finished

Headers​

  • type : RUN_ROUTE_LINK
  • author : client Id as provided in the ìnitialisation message
  • recipients : SDK Id as provided in the ìnitialisation message
  • status : SENT

payload​

  • routeId : string containing the routeId

Example​

Example of a Route itinerary sent
{
    "type": "RUN_ROUTE_LINK",
    "payload": {
        "routeId": "000ZYX1DH01"
    },
    "author": "5DEF55EB-4B07-4155-A0C9-899CD3F18B66",
    "recipients": [
        "sdk_5DEF55EB-4B07-4155-A0C9-899CD3F18B66"
    ],
    "status": "SENT"
}