Skip to main content

Job progress

This message is sent when an API call has been made; it can represent a progression, an API end of process message or an error.

Headers​

  • type : JOB_PROGRESS
  • author : SDK Id
  • recipients : Client Id
  • status : SENT

payload​

  • api : String indicating the API origin (possible values : MPT, MCDI, CARTO)
  • jobId : String for the API job Id
  • action : String for Job process (possible values : AVAILABLE_ROADMAPS, REVERSE_GEOCODE, RUN_MPT, ROUTELINK, MCIINDEPENDANTJOB)
  • progress : String for the progression (possible values : blank, IN_PROGRESS, COMPLETE, ERROR)
  • percent : Integer for percentage when IN_PROGRESS
  • lastMessage : Boolean indicating that the job is finished or not
  • statusCode : HTTP status code
  • message : Displayable message for the job progress
  • entityType (only for MPT or MCDI job) entity type (possible values : MPTJOB, MCIINDEPENDANTJOB, ROUTELINK)
  • jobData : ARJobData : JSON Object describing the job and the result (if succeeded)
  • solutionIndicators : SolutionIndicators Indicators on the MPT Solution for global calculations

ARJobData description for action :

Example​

Example of a successful AVAILABLE_ROADMAPS answer
{
    "type": "JOB_PROGRESS",
    "payload": {
        "api": "CARTO",
        "jobId": "48457835-B708-4B7D-9FC1-12EAEDD5872A",
        "action": "AVAILABLE_ROADMAPS",
        "progress": "COMPLETE",
        "lastMessage": true,
        "statusCode": 200,
        "message": "Default roadmap:FRABELUX_202309",
        "jobData": {
            "default": "FRABELUX_202309",
            "available": [
                "FRABELUX_202309",
                "ITA_202209"
            ]
        }
    },
    "author": "<author id>",
    "recipients": [
        "<recipient id>"
    ],
    "status": "SENT"
}