Devices Endpoint
Table of Contents
Devices Endpoint
You can list, modify and delete the devices on your account.
Create a Device
POST https://api.corvusgps.com/v2/devices/
{
"name": "Josh",
"trackerID": "123456789024680",
"deviceType": "tk_102",
"simPhoneNumber": "555-OPTIONAL"
}
{
"success": "Device has been created successfully!",
"result": {
"1": {
"did": 1,
"name": "Josh",
"uniqueID": null,
"trackerID": "123456789024680",
"deviceType": "tk_102",
"deviceCategory": "device",
"isActive": 1,
"guard": null,
"humidity": null,
"airPressure": null,
"temperature": null,
"lastBatteryLevel": 100,
"lastGPSTimestamp": 1572756668,
"lastKnownAddress": "Veterans Blvd, San Francisco, USA",
"lastValidLatitude": 37.79926,
"lastValidLongitude": -122.46953,
"odometerKM": 6088179.63,
"groupMember": []
}
},
"id": 1,
"resultCount": 1
}
List all your Devices
GET https://api.corvusgps.com/v2/devices/
{
"success": "Devices retrieved successfully!",
"result": {
"1": {
"did": 1,
"name": "Josh",
"uniqueID": null,
"trackerID": "123456789024680",
"deviceType": "gv65",
"deviceCategory": "device",
"isActive": 1,
"guard": null,
"humidity": null,
"airPressure": null,
"temperature": null,
"lastBatteryLevel": 100,
"lastGPSTimestamp": 1572756668,
"lastKnownAddress": "Veterans Blvd, San Francisco, USA",
"lastValidLatitude": 37.79926,
"lastValidLongitude": -122.46953,
"odometerKM": 6088179.63,
"groupMember": [
1
]
}
},
"resultCount": 1
}
List a specific Device
by did (device ID)
GET https://api.corvusgps.com/v2/devices/did/1
or by serial number if it has any
GET https://api.corvusgps.com/v2/devices/uniqueID/0:1
or by IMEI/MEID if it has any
GET https://api.corvusgps.com/v2/devices/trackerID/123456789024680
{
"success": "Devices retrieved successfully!",
"result": {
"1": {
"did": 1,
"name": "Josh",
"uniqueID": "0:1",
"trackerID": "123456789024680",
"deviceType": "evertrack",
"deviceCategory": "trackedUser",
"isActive": 1,
"guard": "installed",
"humidity": null,
"airPressure": null,
"temperature": null,
"lastBatteryLevel": 100,
"lastGPSTimestamp": 1572756668,
"lastKnownAddress": "Veterans Blvd, San Francisco, USA",
"lastValidLatitude": 37.79926,
"lastValidLongitude": -122.46953,
"odometerKM": 6088179.63,
"groupMember": [
1
]
}
},
"resultCount": 1
}
Modify a parameter
PATCH https://api.corvusgps.com/v2/devices/did/1
{
"name": "Bob",
"isActive": 1,
}
{
"success": "Device has been successfully modified!",
"result": {
"1": {
"did": 1,
"name": "Bob",
"uniqueID": null,
"trackerID": "123456789024680",
"deviceType": "tk_102",
"deviceCategory": "device",
"isActive": 1,
"guard": null,
"humidity": null,
"airPressure": null,
"temperature": 23.57,
"lastBatteryLevel": 100,
"lastGPSTimestamp": 1572756668,
"lastKnownAddress": "Veterans Blvd, San Francisco, USA",
"lastValidLatitude": 37.79926,
"lastValidLongitude": -122.46953,
"odometerKM": 6079.63,
"groupMember": [
1
]
}
},
"resultCount": 1
}
Add the tag to group(s)
PUT https://api.corvusgps.com/v2/devices/did/1/groupMember/2,3
{
"success": "Group Memberships successfully modified!",
"result": {
"1": {
"did": 1,
"name": "Bob",
"uniqueID": null,
"trackerID": "123456789024680",
"deviceType": "tk_103",
"deviceCategory": "device",
"isActive": 1,
"guard": null,
"humidity": null,
"airPressure": null,
"temperature": 23.57,
"lastBatteryLevel": 100,
"lastGPSTimestamp": 1572756668,
"lastKnownAddress": "Veterans Blvd, San Francisco, USA",
"lastValidLatitude": 37.79926,
"lastValidLongitude": -122.46953,
"odometerKM": 6079.63,
"groupMember": [
1,
2,
3
]
}
},
"resultCount": 1
}
Remove the tag from group(s)
DELETE https://api.corvusgps.com/v2/devices/did/1/groupMember/1
{
"success": "Removed group memberships successfully!",
"result": {
"1": {
"did": 1,
"name": "Bob",
"uniqueID": ,
"trackerID": "123456789024680",
"deviceType": "tk_305",
"deviceCategory": "device",
"isActive": 1,
"guard": null,
"humidity": null,
"airPressure": null,
"temperature": 23.37,
"lastBatteryLevel": 100,
"lastGPSTimestamp": 1572756668,
"lastKnownAddress": "Veterans Blvd, San Francisco, USA",
"lastValidLatitude": 37.79926,
"lastValidLongitude": -122.46953,
"odometerKM": 6079.63,
"groupMember": [
2,
3
]
}
},
"resultCount": 1
}
Delete a Device
DELETE https://api.corvusgps.com/v2/devices/did/1
{
"success": "Device has been deleted successfully!"
}