POST /rids/:rid - Send data to single device

Owned by Mikko Haapalehto
Last updated: Jul 27, 2016 by Janne Virtala
1 min read

Send point to point message to single rid

Request Uri Parameters

ParameterDatatype
ridstring

Request Http Post Parameter Parameters

ParameterDatatypeDescription
payloadHttp Post ParameterHttp Post parameter which contains Array of JSON objects which are sent to a client

JSON parameters in Request's payload

ParameterDescription
ridHttp Post parameter which contains Array of JSON objects which are sent to a client
payload_typeOptional parameters, which describes payload's data type. Possible values are: STRING, INT, BINARY
payload

Data which is sent to client. For payload_type STRING this should be a string, for INT a 32 bit signed integer and for BINARY a string containing base64 encoded binary data.

Example Client Request

POST /rids/example_rid HTTP/1.1
ApiKey: example_apikey
Content-Length: 100
Content-Type: text/plain; charset=ISO-8859-1
Host: localhost:8888
Connection: Keep-Alive
payload=[{"rid":"example_rid","payload_type":"STRING","payload":"this is data to be sent a client"}]

Example Server Response

HTTP/1.1 200 OK

Content-Type: application/json

Content-Length: 21

{"result": "EnRoute"}

Response Status Codes

Server will return 200 on success case

For error cases see: Error Status Codes

ParameterDatatypeDescription
resultstringString representation of end result