Skip to main content

Selected entities

This will update the selected entities on the mapview. There are 3 kinds of entities that can be selected: routes, sequences and orders

Headers

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

payload

  • entitiesRef : List of selected entities

Each entity of the list can be one of the following:

Examples

Example of a selected order
{
"type": "SET_SELECTED_ENTITIES",
"payload": {
"entitiesRef": [
{
"entityType": "OPERATION",
"orderId": "OPERATION_07",
"idxSplit": 0
}
]
},
"author": "<author id>",
"recipients": [
"<recipient id>"
],
"status": "SENT"
}
Example of a selected sequence
{
"type": "SET_SELECTED_ENTITIES",
"payload": {
"entitiesRef": [
{
"entityType": "ACTIVITY",
"routeId": "000ZYX1DH01",
"index": 6
}
]
},
"author": "<author id>",
"recipients": [
"<recipient id>"
],
"status": "SENT"
}
Example of selected route
{
"type": "SET_SELECTED_ENTITIES",
"payload": {
"entitiesRef": [
{
"entityType": "ITINERARY",
"routeId": "000ZYX1DH01",
}
]
},
"author": "<author id>",
"recipients": [
"<recipient id>"
],
"status": "SENT"
}```