Skip to main content

Entities

This message allows to send or update the working datas to the SDK with the function SendEvent.

Headers​

  • type : SET_SDK_ENTITIES
  • author : client Id as returned by SDK in the ìnitialization answer message
  • recipients : List of SDK Ids as returned by SDK in the ìnitialization answer message
  • status : SENT

Payload​

Examples​

Logistic sites
{
    "type": "SET_SDK_ENTITIES",
    "payload": {
        "sites": [
            {
                "id": "AXIOROUTE",
                "coordinates": {
                    "longitude": -0.561642,
                    "latitude": 47.462544
                },
                "isDepot": false
            },
            {
                "id": "CJM",
                "coordinates": {
                    "longitude": -0.345602,
                    "latitude": 48.597481
                },
                "isDepot": false
            },
            {
                "id": "COFISOFT",
                "coordinates": {
                    "longitude": 1.697037,
                    "latitude": 46.816713
                },
                "isDepot": false
            },
            {
                "id": "GPI",
                "coordinates": {
                    "longitude": 4.740329,
                    "latitude": 45.752201
                },
                "isDepot": false
            },
            {
                "id": "SINARI",
                "coordinates": {
                    "longitude": -1.604869,
                    "latitude": 48.113197
                },
                "isDepot": true
            },
            {
                "id": "XYRIC",
                "coordinates": {
                    "longitude": 5.09304,
                    "latitude": 47.310967
                },
                "isDepot": false
            }
        ]
    },
    "author": "<author id>",
    "recipients": [
        "<recipient id>"
    ],
    "status": "SENT"
}
Transport operations
{
	"type": "SET_SDK_ENTITIES",
	"payload": {
		"sites": [
			{
				"id": "AXIOROUTE",
				"coordinates": {
					"longitude": -0.561642,
					"latitude": 47.462544
				},
				"isDepot": false
			},
			{
				"id": "CJM",
				"coordinates": {
					"longitude": -0.345602,
					"latitude": 48.597481
				},
				"isDepot": false
			},
			{
				"id": "COFISOFT",
				"coordinates": {
					"longitude": 1.697037,
					"latitude": 46.816713
				},
				"isDepot": false
			},
			{
				"id": "GPI",
				"coordinates": {
					"longitude": 4.740329,
					"latitude": 45.752201
				},
				"isDepot": false
			},
			{
				"id": "SINARI",
				"coordinates": {
					"longitude": -1.604869,
					"latitude": 48.113197
				},
				"isDepot": true
			},
			{
				"id": "XYRIC",
				"coordinates": {
					"longitude": 5.09304,
					"latitude": 47.310967
				},
				"isDepot": false
			}
		],
		"operations": [
			{
				"id": "OPERATION_01",
				"type": "DELIVERY",
				"idSiteDestination": "AXIOROUTE"
			},
			{
				"id": "OPERATION_02",
				"type": "DELIVERY",
				"idSiteDestination": "COFISOFT"
			},
			{
				"id": "OPERATION_03",
				"type": "DELIVERY",
				"idSiteDestination": "CJM"
			},
			{
				"id": "OPERATION_04",
				"type": "DELIVERY",
				"idSiteDestination": "GPI"
			},
			{
				"id": "OPERATION_05",
				"type": "DELIVERY",
				"idSiteDestination": "XYRIC"
			}
		]
	},
	"author": "<author id>",
	"recipients": [
		"<recipient id>"
	],
	"status": "SENT"
}