Response Events

This section provides examples for Response Event types.

Current API

URI Method Description 
/ids-data-api/v1/response-events/current/{deviceId}?responseType=<type>
 GET This API retrieves the most recent response events of the specified device. It provides option to filter the data for specific responseType.

Method: GET

URI: 

http://<<IDShostname>>/ids-data-api/v1/response-events/current/352253064335021?param=/device/0/battery&responseType=read

Response: 200 OK:

[
{
"groupName": "tempco",
"deviceId": "352253064335021",
"serverTime": "2017-01-25T10:23:33.341+0000",
"param": "/device/0/battery",
"value": "0",
"requestId": "968703ad-971a-476f-9f28-5db797c1c17c",
"resultCode": "0",
"resultSubCode": "null",
"resultReason": "SUCCESS",
"responseType": "read"
}
]

Historical API

URI Method Description 
/ids-data-api/v1/response-events/history?fromTime=<fromTime>&toTime=<toTime>&deviceId=<deviceIds>&responseType=<type>
 GET

This API retrieves all the response event values of specified devices' parameters and event type in the specified time range.

If specific parameters are specified in " + "as part of the request params then only those specific parameters will be retrieved.

Method: GET

URI: 
http://<<IDShostname>>/ids-data-api/v1/response-events/history?fromTime=2017-01-25T00:00:00&toTime=2020-06-16T23:00:00&deviceId=352253064335021, 352753095787619&param=/device/0/battery&pageSize=3&responseType=read

Response: 200 OK:

[
{
"groupName": "tempco",
"deviceId": "352253064335021",
"serverTime": "2017-01-25T10:23:33.341+0000",
"param": "/device/0/battery",
"value": "0",
"requestId": "968703ad-971a-476f-9f28-5db797c1c17c",
"resultCode": "0",
"resultSubCode": "null",
"resultReason": "SUCCESS",
"responseType": "read"
},
{
"groupName": "tempco",
"deviceId": "352753095787619",
"serverTime": "2017-01-25T10:23:33.341+0000",
"param": "/device/0/battery",
"value": "0",
"requestId": "968703ad-971a-476f-9f28-5db797c1c17d",
"resultCode": "0",
"resultSubCode": "null",
"resultReason": "SUCCESS",
"responseType": "read"
}
]

Bulk APIs

URI Method Description 
/ids-data-api/v1/response-events/bulk?fromTime=<fromTime>&toTime=<toTime>
 GET

This API retrieves all the response events of all the devices in the specified time range for all the response event type.

The response consists of a list of JSON formatted data, separated by newlines.

Method: GET

URI: 
http://<<IDShostname>>/ids-data-api/v1/response-events/bulk?fromTime=2017-01-25T00:00:00&toTime=2020-06-18T23:00:00

Response: 200 OK:

{"groupName":"tempco","deviceId":"352753095787619", "serverTime":"2017-01-25T10:23:33.341+0000", "param":"/device/0/battery","value":"0", "requestId":"968703ad-971a-476f-9f28-5db797c1c17c", "resultCode":"0","resultSubCode":"null", "resultReason":"SUCCESS","responseType": "read"}
{"groupName":"tempco","deviceId":"352253064335021", "serverTime":"2017-01-25T10:23:33.341+0000", "param":"/device/0/pressure","value":"0", "requestId":"968703ad-971a-476f-9f28-5db797c1c17d", "resultCode":"0","resultSubCode":"null", "resultReason":"SUCCESS","responseType": "read"}