POST api/DEVICES?foreigns={foreigns}
Insert a single record into DEVICES
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| foreigns |
Optional. Default value is false. True=> Include nested foreign objects within reply. False=> Do NOT Include nested foreign objects within reply |
boolean |
Default value is False |
Body Parameters
Obligatory. The new DEVICES object that need to be added
DEVICES| Name | Description | Type | Additional information |
|---|---|---|---|
| DEVICE_ID | integer |
None. |
|
| FK_CUSTODIAN | integer |
None. |
|
| TOKEN | string |
Required String length: inclusive between 0 and 300 |
|
| DEVICE_TYPE |
0/false => IOS, 1/true => ANDROID |
boolean |
None. |
| UDID | string |
Required String length: inclusive between 0 and 50 |
|
| CUSTODIANS | CUSTODIANS |
None. |
Request Formats
application/json, text/json
Sample:
{
"DEVICE_TYPE": true,
"FK_CUSTODIAN": 2,
"DEVICE_ID": 1,
"CUSTODIANS": {
"ACTIVE": true,
"CUSTODIAN_TYPE": 64,
"CUSTODIAN_ID": 1,
"LAST_NOTIFY_DELETE": "2025-12-07T09:12:13.5265312Z",
"NOTES": "sample string 7",
"LOGIN_PASSWORD": "sample string 5",
"LOGIN_NAME": "sample string 4",
"CUSTODIAN_NAME": "sample string 2"
},
"UDID": "sample string 5",
"TOKEN": "sample string 3"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DEVICES_CMD_RESPONSE| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | Status |
None. |
|
| DATA | Collection of DEVICES |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": {
"Success": true,
"Code": "0",
"DetailedMessage": "sample string 3",
"Message": "sample string 2"
},
"DATA": [
{
"DEVICE_TYPE": true,
"FK_CUSTODIAN": 2,
"DEVICE_ID": 1,
"CUSTODIANS": {
"ACTIVE": true,
"CUSTODIAN_TYPE": 64,
"CUSTODIAN_ID": 1,
"LAST_NOTIFY_DELETE": "2025-12-07T09:12:13.5285144Z",
"NOTES": "sample string 7",
"LOGIN_PASSWORD": "sample string 5",
"LOGIN_NAME": "sample string 4",
"CUSTODIAN_NAME": "sample string 2"
},
"UDID": "sample string 5",
"TOKEN": "sample string 3"
},
{
"DEVICE_TYPE": true,
"FK_CUSTODIAN": 2,
"DEVICE_ID": 1,
"CUSTODIANS": {
"ACTIVE": true,
"CUSTODIAN_TYPE": 64,
"CUSTODIAN_ID": 1,
"LAST_NOTIFY_DELETE": "2025-12-07T09:12:13.5285144Z",
"NOTES": "sample string 7",
"LOGIN_PASSWORD": "sample string 5",
"LOGIN_NAME": "sample string 4",
"CUSTODIAN_NAME": "sample string 2"
},
"UDID": "sample string 5",
"TOKEN": "sample string 3"
}
]
}
