Skip to main content

Current entities

This will update the current entity on the mapview, there are 3 possibilities :

  • a route becomes current (with no activity linked)
  • an activity becomes current (so the route bacomes also the current one)
  • an operation that is not on a route becomes current

Headers

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

payload

Examples

Example of a current feature on an operation
{
"type": "SET_CURRENT_ENTITIES",
"payload": {
"entityType": "OPERATION",
"orderId": "OPERATION_07",
"idxSplit": 0
},
"author": "<author id>",
"recipients": [
"<recipient id>"
],
"status": "SENT"
}
Example of a current feature on a sequence
{
"type": "SET_CURRENT_ENTITIES",
"payload": {
"entityType": "ACTIVITY",
"routeId": "000ZYX1DH01",
"index": 10
},
"author": "<author id>",
"recipients": [
"<recipient id>"
],
"status": "SENT"
}
Example of a current feature on a route
{
"type": "SET_CURRENT_ENTITIES",
"payload": {
"entityType": "ITINERARY",
"routeId": "000ZYX1DH01"
},
"author": "<author id>",
"recipients": [
"<recipient id>"
],
"status": "SENT"
}