List Device Objects created by customer user on the account
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/devicesRetrieve |
| Method | POST |
| Body | Devices Retrieve Object |
| Note | The request parameter attribute “fieldset” is set to “all_fields” to request the platform return all records of the device objects. The fieldset can be set to return specific records as demonstrated in the next examples. |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "fieldset":[ "all_fields" ], "limit":6, "page":1, "match_conditions":{ }, "udid_list":[ ], "imsi_list":[ ], "device_id_list":[ ] } } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":[ { "state":false, "customer_id":"5a393ea210d91806b7ef702c", "udid":"574836f16f1cad0a547164ec", "device_name":"module 5003 platform v66", "device_id":"", "imsi":"234990000001234", "imei":"35-200123-100123-15", "device_model":"", "device_firmware":"t318", "device_type":"", "device_ip":"198.62.75.121", "device_port":5000, "device_app_protocol":"", "service_template_id":"config_profile_utililty_group1", "device_token":"SKDf8rCuD6nRbrKgJvXLqB73", "auto_capture_device_token":false, "first_session":"", "disconnection_time":"", "last_accessed_sap_list":[ ], "last_activity":"2015-09-29T10:11:33.548Z", "last_wakeup":"2015-09-29T10:11:15.213Z", "connection_time":"2015-08-15T12:01:34.354Z ", "signal_strength":"164", "power_usage_info":"1.2", "gpsloc_long":"4.8952° E", "gpsloc_lat":"52.3702° N", "create_time":"2015-03-12T21:05:27.432Z", "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "custom_field_1":"", "custom_field_2":"" }, { "state":true, "customer_id":"5a393ea210d91806b7ef702c", "udid":"5a623f4ddd59545193ea9b6c", "device_name":"GAS_Meter_CSM", "device_id":"iot_7aiud", "device_ip":"", "device_port":0, "imei":"", "imsi":"", "device_model":"", "device_firmware":"f5612r1", "device_type":"", "device_app_protocol":"", "service_template_id":"config_profile_SmartDev_r22", "device_token":"5extLWWv5qfNKKdDnE", "auto_capture_device_token":false, "first_session":"", "disconnection_time":"", "last_accessed_sap_list":[ ], "last_activity":"2015-09-29T10:11:23.412Z", "last_wakeup":"2015-09-29T10:11:22.934Z", "connection_time":"2015-09-03T07:23:33.764Z ", "signal_strength":"150", "power_usage_info":"676", "gpsloc_long":"13.4050° E", "gpsloc_lat":"52.5200° N", "create_time":"2014-03-12T21:05:27.432Z", "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "custom_field_1":"", "custom_field_2":"" }, { "state":true, "customer_id":"5a393ea210d91806b7ef702c", "udid":"5a623f4ddd59545193ea9b6d", "device_name":"GAS_Meter_CSM", "device_id":"iot_D8judS", "device_ip":"", "device_port":0, "imei":"", "imsi":"", "device_model":"", "device_firmware":"f5612r1", "device_type":"vim", "device_app_protocol":"", "service_template_id":"config_profile_SmartDev_r22", "device_token":"YpAjD6Sss9kDB4VPJh", "auto_capture_device_token":false, "first_session":"", "disconnection_time":"", "last_accessed_sap_list":[ ], "last_activity":"2015-09-28T14:25:23.189Z", "last_wakeup":"2015-09-28T14:22:22.431Z", "connection_time":"2015-06-26T09:01:05.874Z ", "signal_strength":"149", "power_usage_info":"677", "gpsloc_long":"", "gpsloc_lat":"", "create_time":"2014-03-12T21:05:29.802Z", "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "custom_field_1":"", "custom_field_2":"" }, { "state":true, "customer_id":"5a393ea210d91806b7ef702c", "udid":"5aa5d6f172bb547e07364363", "device_name":"TCU Group 1 Banbury", "device_id":"98u6-5677-t67de3-6545", "device_ip":"", "device_port":0, "imei":"", "imsi":"", "device_model":"", "device_firmware":"", "device_type":"", "device_app_protocol":"", "service_template_id":"config_profile_SmartDev_r22", "device_token":"", "auto_capture_device_token":true, "first_session":"", "disconnection_time":"", "last_accessed_sap_list":[ ], "last_activity":"2015-09-10T09:51:23.132Z", "last_wakeup":"2015-09-10T09:49:55.785Z", "connection_time":"2015-09-05T23:49:05.435Z ", "signal_strength":"", "power_usage_info":"", "gpsloc_long":"", "gpsloc_lat":"", "create_time":"2015-03-12T01:25:23.065Z", "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "custom_field_1":"", "custom_field_2":"" }, { "state":true, "customer_id":"5a393ea210d91806b7ef702c", "udid":"5aa5d6f172bb547e07364364", "device_name":"TCU Group 1 Banbury", "device_id":"98u6-5677-t67de3-6546", "device_ip":"", "device_port":0, "imei":"", "imsi":"", "device_model":"", "device_firmware":"", "device_type":"", "device_app_protocol":"", "service_template_id":"config_profile_SmartDev_r22", "device_token":"", "auto_capture_device_token":true, "first_session":"", "disconnection_time":"", "last_accessed_sap_list":[ ], "last_activity":"2015-09-27T15:18:47.276Z", "last_wakeup":"2015-09-27T15:18:40.754Z", "connection_time":"2015-09-27T04:08:34.871Z ", "signal_strength":"", "power_usage_info":"", "gpsloc_long":"", "gpsloc_lat":"", "create_time":"2015-03-12T01:25:55.235Z", "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "custom_field_1":"", "custom_field_2":"" }, { "state":true, "customer_id":"5a393ea210d91806b7ef702c", "udid":"5aa5d70372bb547e07364365", "device_name":"TCU Group 1 Banbury", "device_id":"98u6-5677-t67de3-6547", "device_ip":"", "device_port":0, "imei":"", "imsi":"", "device_model":"", "device_firmware":"", "device_type":"", "device_app_protocol":"", "service_template_id":"config_profile_SmartDev_r22", "device_token":"", "auto_capture_device_token":true, "first_session":"", "disconnection_time":"", "last_accessed_sap_list":[ ], "last_activity":"2015-09-29T13:18:29.526Z", "last_wakeup":"2015-09-29T13:18:14.483Z", "connection_time":"2015-09-27T11:12:45.213Z ", "signal_strength":"", "power_usage_info":"", "gpsloc_long":"", "gpsloc_lat":"", "create_time":"2015-03-12T01:26:00.126Z", "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "custom_field_1":"", "custom_field_2":"" } ] } |
List Device Objects limit each object record to specified fields only
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/devicesRetrieve |
| Method | POST |
| Body | Devices Retrieve Object |
| Notes | By limiting to limited set of fields only the user is allowed to retrieve up to 10,000 device object records per page. If fieldset is set to retrieve all fields the device objects returned per response (page) is 1000. In either case user is still able to retrieve 1,000,000,000 device objects using pagination. |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "fieldset":[ "udid ", "device_ip", "last_activity", "signal_strength", "power_usage_info", "gpsloc_long", "gpsloc_lat" ], "limit":6, "page":1, "match_conditions":{ }, "udid_list":[ ], "imsi_list":[ ], "device_id_list":[ ] } } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":[ { "udid":"574836f16f1cad0a547164ec", "device_ip":"198.62.75.121", "last_activity":"2015-09-29T10:11:33.548Z", "signal_strength":"164", "power_usage_info":"1.2", "gpsloc_long":"4.8952° E", "gpsloc_lat":"52.3702° N" }, { "udid":"5a623f4ddd59545193ea9b6c", "device_ip":"", "last_activity":"2015-09-29T10:11:23.412Z", "signal_strength":"150", "power_usage_info":"676", "gpsloc_long":"13.4050° E", "gpsloc_lat":"52.5200° N" }, { "udid":"5a623f4ddd59545193ea9b6d", "device_ip":"", "last_activity":"2015-09-28T14:25:23.189Z", "signal_strength":"149", "power_usage_info":"677", "gpsloc_long":"", "gpsloc_lat":"" }, { "udid":"5aa5d6f172bb547e07364363", "device_ip":"", "last_activity":"2015-09-10T09:51:23.132Z", "signal_strength":"", "power_usage_info":"", "gpsloc_long":"", "gpsloc_lat":"" }, { "udid":"5aa5d6f172bb547e07364364", "device_ip":"", "last_activity":"2015-09-27T15:18:47.276Z", "signal_strength":"", "power_usage_info":"", "gpsloc_long":"", "gpsloc_lat":"" }, { "udid":"5aa5d70372bb547e07364365", "device_ip":"", "last_activity":"2015-09-29T13:18:29.526Z", "signal_strength":"", "power_usage_info":"", "gpsloc_long":"", "gpsloc_lat":"" } ] } |
Retrieve specific device(s) by their Unique Device ID (UDID)
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/service_provisioning/devicesRetrieve |
| Method | POST |
| Body | Devices Retrieve Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "fieldset":[ "udid ", "device_ip", "last_activity", "signal_strength", "power_usage_info", "gpsloc_long", "gpsloc_lat" ], "match_conditions":{ }, "udid_list":[ "574836f16f1cad0a547164ec", "5a623f4ddd59545193ea9b6c", "5aa5d6f172bb547e07364364" ], "imsi_list":[ ], "device_id_list":[ ] } } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":[ { "udid":"574836f16f1cad0a547164ec", "device_ip":"198.62.75.121", "last_activity":"2015-09-29T10:11:33.548Z", "signal_strength":"164", "power_usage_info":"1.2", "gpsloc_long":"4.8952° E", "gpsloc_lat":"52.3702° N" }, { "udid":"5a623f4ddd59545193ea9b6c", "device_ip":"", "last_activity":"2015-09-29T10:11:23.412Z", "signal_strength":"150", "power_usage_info":"676", "gpsloc_long":"13.4050° E", "gpsloc_lat":"52.5200° N" }, { "udid":"5aa5d6f172bb547e07364364", "device_ip":"", "last_activity":"2015-09-27T15:18:47.276Z", "signal_strength":"", "power_usage_info":"", "gpsloc_long":"", "gpsloc_lat":"" } ] } |
Retrieve specific device(s) by their International Mobile Subscriber Identity (IMSI)
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/service_provisioning/devicesRetrieve |
| Method | POST |
| Body | Devices Retrieve Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "fieldset":[ "state", "imsi ", "device_ip", "device_port", "last_activity", "signal_strength" ], "match_conditions":{ }, "udid_list":[ ], "imsi_list":[ "234990000001234" ], "device_id_list":[ ] } } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":[ { "state":false, "imsi":"234990000001234", "device_ip":"198.62.75.121", "device_port":5000, "last_activity":"2015-09-29T10:11:33.548Z", "signal_strength":"164" } ] } |
Retrieve specific device(s) by their custom Device Identifier (device_id)
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/service_provisioning/devicesRetrieve |
| Method | POST |
| Body | Devices Retrieve Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "fieldset":[ "udid ", "device_ip", "last_activity", "signal_strength", "power_usage_info", "gpsloc_long", "gpsloc_lat" ], "match_conditions":{ }, "udid_list":[ ], "imsi_list":[ ], "device_id_list":[ "iot_D8judS", "98u6-5677-t67de3-6545" ] } } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":[ { "udid":"5a623f4ddd59545193ea9b6d", "device_ip":"", "last_activity":"2015-09-28T14:25:23.189Z", "signal_strength":"149", "power_usage_info":"677", "gpsloc_long":"", "gpsloc_lat":"" }, { "udid":"5aa5d6f172bb547e07364363", "device_ip":"", "last_activity":"2015-09-10T09:51:23.132Z", "signal_strength":"", "power_usage_info":"", "gpsloc_long":"", "gpsloc_lat":"" } ] } |
Retrieve list of device objects that match specific status and conditions
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/service_provisioning/devicesRetrieve |
| Method | POST |
| Body | Devices Retrieve Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "fieldset":[ "device_id", "device_name", "last_activity" ], "limit":50, "page":1, "udid_list":[ ], "imsi_list":[ ], "device_id_list":[ ], "match_conditions":{ "state":true, "service_template_id":"config_profile_SmartDev_r22" } } } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":[ { "device_name":"GAS_Meter_CSM", "device_id":"iot_7aiud", "last_activity":"2015-09-29T10:11:23.412Z" }, { "device_name":"GAS_Meter_CSM", "device_id":"iot_D8judS", "last_activity":"2015-09-28T14:25:23.189Z" }, { "device_name":"TCU Group 1 Banbury", "device_id":"98u6-5677-t67de3-6545", "last_activity":"" }, { "device_name":"TCU Group 1 Banbury", "device_id":"98u6-5677-t67de3-6546", "last_activity":"2015-09-10T09:51:23.132Z" }, { "device_name":"TCU Group 1 Banbury", "device_id":"98u6-5677-t67de3-6547", "last_activity":"2015-09-29T13:18:29.526Z" } ] } |
Note:
Any of the following match condition can be specified. Only customer device objects that match ALL the specified conditions will be returned. The timestamp format are in ISO date. The timestamp, power usage and signal strength filter (range type conditions) must be supplied in an array of [“start value”, “end value”].
Example below provides an overview of all attributes of match_conditions that device objects can be searched and matched against.
Any of the following match condition can be specified. Only customer device objects that match ALL the specified conditions will be returned. The timestamp format are in ISO date. The timestamp, power usage and signal strength filter (range type conditions) must be supplied in an array of [“start value”, “end value”].
Example below provides an overview of all attributes of match_conditions that device objects can be searched and matched against.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
"match_conditions":{ "state" :true, //BOOLEAN "device_port" : 3000, // PORT NUMBER "device_ip" : "10.10.1.1", // IP ADDRESS "device_app_protocol" : "coap", // raw or coap or other supported app protocol "service_template_id" : "config_template_1", // service_template_id "service_access_point": "doodle", // SAP name "gpsloc_long" : "053933939393", //GPS long "gpsloc_lat" : "68899889999999", //GPS LAT "disconnection_time" : ["2017-03-04T00:00:00Z", "2017-03-09T00:00:00Z"], //TIMESTAMP RANGE "last_activity" : ["2017-03-04T00:00:00Z", "2017-03-09T00:00:00Z"], //TIMESTAMP RANGE "last_wakeup" : ["2017-03-04T00:00:00Z", "2017-03-09T00:00:00Z"], //TIMESTAMP RANGE "connection_time" : ["2017-03-04T00:52:43.822Z", "2017-03-09T00:52:43.822Z"], //TIMESTAMP RANGE "power_usage_stats" : [0.5, 22], //POWER USAGE RANGE "signal_strength" : [-55, -22] //SIGNAL STRENGTH RANGE } |
Retrieve device objects whereby last_activity timestamp is between the specified start and end date
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/devicesRetrieve |
| Method | POST |
| Body | Devices Retrieve Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "fieldset":[ "device_id", "device_name", "last_activity" ], "limit":50, "page":1, "udid_list":[ ], "imsi_list":[ ], "device_id_list":[ ], "match_conditions":{ "last_activity":[ "2015-09-28T10:00:00.000Z", "2015-09-29T10:00:00.000Z" ] } } } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":[ { "device_name":"GAS_Meter_CSM", "device_id":"iot_7aiud", "last_activity":"2015-09-29T10:11:23.412Z" }, { "device_name":"GAS_Meter_CSM", "device_id":"iot_D8judS", "last_activity":"2015-09-28T14:25:23.189Z" } ] } |
Create one or more Devices
| Property | Description |
| Resource URL | /customer/v1/{customer_id}/service_provisioning/devicesUpdate |
| Method | POST |
| Body | Device Object List |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":[ { "device_id":"", "device_name":"gas_tank_g2", "service_template_id":"config_profile_utililty_group1", "state":true, "device_type":"", "device_model":"", "device_firmware":"", "imsi":"901995678912341", "imei":"", "device_ip":"", "device_port":"", "device_app_protocol":"", "gpsloc_lat":"51.2277° N", "gpsloc_long":"6.7735° E", "auto_capture_device_token":false, "device_token":"", "pki_auth_pem_dev_cert":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_srv_key":"" }, { "device_name":"gas_tank_g2", "service_template_id":"config_profile_utililty_group1XXZZZXXZZ", "state":true, "imsi":"234991123456789", "gpsloc_lat":"51.2277° N", "gpsloc_long":"6.7735° E" }, { "device_name":"gas_smart_k55", "service_template_id":"config_profile_SmartDev_r22", "state":true } ] } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":{ "error_queue":[ { "device_id":"", "device_name":"gas_tank_g2", "service_template_id":"config_profile_utililty_group1XXZZZXXZZ", "state":true, "device_type":"", "device_model":"", "device_firmware":"", "imsi":"234991123456789", "imei":"", "device_ip":"", "device_port":"", "device_app_protocol":"", "gpsloc_lat":"51.2277° N", "gpsloc_long":"6.7735° E", "auto_capture_device_token":false, "device_token":"", "pki_auth_pem_dev_cert":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_srv_key":"", "error":"config_profile_utililty_group1XXZZZXXZZ not found - valid service_template_id required" } ], "completed_queue":[ { "udid":"5ab7fe554b04a933f459da0d", "state":true, "device_id":"", "service_template_id":"config_profile_utililty_group1", "device_port":0, "device_ip":"", "imsi":"901995678912341", "imei":"", "device_name":"gas_tank_g2", "device_model":"", "device_firmware":"", "device_type":"", "device_token":"", "last_activity":null, "last_wakeup":null, "connection_time":null, "signal_strength":"", "gpsloc_lat":"51.2277° N", "gpsloc_long":"6.7735° E", "create_time":"2016-03-25T19:53:57.729Z", "auto_capture_device_token":false, "first_session":null, "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "disconnection_time":null, "last_accessed_sap_list":[ ], "custom_field_1":"", "custom_field_2":"" }, { "udid":"5ab7fe554b04a933f459da0e", "state":true, "device_id":"", "service_template_id":"config_profile_SmartDev_r22", "device_port":0, "device_ip":"", "imsi":"", "imei":"", "device_name":"gas_smart_k55", "device_model":"", "device_firmware":"", "device_type":"", "device_token":"", "last_activity":null, "last_wakeup":null, "connection_time":null, "signal_strength":"", "gpsloc_long":"", "gpsloc_lat":"", "create_time":"2016-03-25T19:53:57.729Z", "auto_capture_device_token":false, "first_session":null, "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "disconnection_time":null, "last_accessed_sap_list":[ ], "custom_field_1":"", "custom_field_2":"" } ] } } |
Note:
A unique device identifier (UDID) is assigned to each device object successfully created.
A unique device identifier (UDID) is assigned to each device object successfully created.
Update one or more Devices
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/devicesUpdate |
| Method | PUT |
| Body | Device Object List |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":[ { "udid":"5ab7fe554b04a933f459da0d", "state":true, "service_template_id":"config_profile_utililty_group1", "device_name":"gas_tank_g3", "device_token":"jV3dUvNQn6246Dfe1v" }, { "udid":"5ab7fe554b04a933f459da0e", "state":false, "device_id":"Q3009qC1001", "service_template_id":"config_profile_utililty_group1" } ] } |
Sample Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":{ "error_queue":[ ], "completed_queue":[ { "udid":"5ab7fe554b04a933f459da0d", "state":true, "device_id":"", "service_template_id":"config_profile_utililty_group1", "device_port":0, "device_ip":"", "imsi":"901995678912341", "imei":"", "device_name":"gas_tank_g3", "device_model":"", "device_firmware":"", "device_type":"", "device_token":"jV3dUvNQn6246Dfe1v", "last_activity":null, "last_wakeup":null, "connection_time":null, "signal_strength":"", "gpsloc_lat":"51.2277° N", "gpsloc_long":"6.7735° E", "create_time":"2016-03-25T19:53:57.729Z", "auto_capture_device_token":false, "first_session":null, "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "disconnection_time":null, "last_accessed_sap_list":[ ], "custom_field_1":"", "custom_field_2":"" }, { "udid":"5ab7fe554b04a933f459da0e", "state":false, "device_id":"Q3009qC1001", "service_template_id":"config_profile_utililty_group1", "device_port":0, "device_ip":"", "imsi":"", "imei":"", "device_name":"gas_smart_k55", "device_model":"", "device_firmware":"", "device_type":"", "device_token":"", "last_activity":null, "last_wakeup":null, "connection_time":null, "signal_strength":"", "gpsloc_long":"", "gpsloc_lat":"", "create_time":"2016-03-25T19:53:57.729Z", "auto_capture_device_token":false, "first_session":null, "radius_auth_password":"", "radius_auth_username":"", "pki_auth_pem_srv_key":"", "pki_auth_pem_srv_cert":"", "pki_auth_pem_dev_cert":"", "disconnection_time":null, "last_accessed_sap_list":[ ], "custom_field_1":"", "custom_field_2":"" } ] } } |
Delete one or more device(s)
| Property | Description |
| Resource URL | /customer/v1/{customer_id} /service_provisioning/devicesDelete |
| Method | POST |
| Body | Devices Delete Object |
Sample Request
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
POST /customer/v1/5a393ea210d91806b7ef702c/service_provisioning/devicesRetrieve HEADER authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIiLCJpYXQiOjEzMzIwNjk5MDIsImV4cCI6MTUyMTM3NDE5OSwiYXVkIjoiIiwic3ViIjoiIiwiY3VzdG9tZXJfaWQiOiI1YTM5M2VhMjEwZDkxODA2YjdlZjcwMmMifQ.u4kBXOHCP7W-Vg9oSfkFniSKbxj8t1ULMnTcCAS2ykw { "request_id":"", "request_parameters":{ "udid_list":[ "574836f16f1cad0a547164ec", "5a623f4ddd59545193ea9b6c", "5aa5d6f172bb547e07364364" ], "imsi_list":[ ], "device_id_list":[ ] } } |
Sample Response
|
1 2 3 4 5 6 |
{ "request_id":"", "result_code":0, "result_description":"Success", "response":"" } |
Note:
One or more udid, imsi or device_id lists can be provided to specify which device object is to be deleted.
One or more udid, imsi or device_id lists can be provided to specify which device object is to be deleted.