...
{ | Field | Description |
“statusCode”: 200, | Request successful | |
“data”: { | Response data | |
“smdmId”: <new device model id> | New device model id. | |
} | ||
} |
GET all existing devices
This API allows getting information about all existing device models:
Verb | GET |
Resource | /api/datamanagement/v1/SMDeviceModels |
The response data is a JSON object with the following structure:
| Code Block |
|---|
{
"statusCode":200,
"data":{
"SMDeviceModels":[
{
"smdmId":0,
"smdmModel":"Unspecified",
"smdmMetricProfile":0,
"smdmCreatedAt":"2020-11-20 15:55:35",
"smdmUpdatedAt":"2020-11-20 15:55:35",
"smdmDeletedAt":null,
"SMDevices":[
{
"smrdId":0,
"smrdTerminalId":"",
"smrdIMEI":"000000000000000",
"smrdModel":0,
"smrdState":1,
"smrdCreatedAt":"2020-11-20 15:54:56",
"smrdUpdatedAt":"2020-11-20 15:54:56",
"smrdDeletedAt":null
}
],
"SMRuleOverrides":[
],
"SMCriteriaOverrides":[
]
},
...
]
}
} |
GET an existing device model
This API allows retrieving device model data from the SAM database:
...
The response data is a JSON object with the following structure:
...
{
...
Field
...
Description
...
“statusCode”: 200,
...
Request successful
...
“data”: {
...
Response data
...
“SMDeviceModels”: [<device model>*]
...
<device model>* is the list of device model records, represented as Json objects. See the SAM database model document for a description of the Json object structure.
If a device model id is specified (e.g. /6) the list will contain only the device model of the specified id (smdmId==id).
...
}
| Code Block |
|---|
{ "statusCode":200, "data":{ "SMDeviceModels":[ { "smdmId":3, "smdmModel":"Samsung S9", "smdmMetricProfile":0, "smdmCreatedAt":"2022-06-24 13:23:08", "smdmUpdatedAt":"2022-06-24 13:23:08", "smdmDeletedAt":null, "SMDevices":[ ], "SMRuleOverrides":[ ], "SMCriteriaOverrides":[ ] } ] } } |
UPDATE an existing device model
...
The response data is a JSON object with the following structure:
...
{
...
Field
...
Description
...
“statusCode”: 200,
...
Request successful
| Code Block |
|---|
{"statusCode":200} |
DELETE an existing device model
...
The response data is a JSON object with the following structure:
| Code Block |
|---|
{ |
...
Field
...
Description
...
"statusCode:200 |
...
Request successful
"} |