Users Endpoint
Table of Contents
Users Endpoint
You can list, modify, add and remove users on your account.
Create a User
POST https://api.corvusgps.com/v2/users/
{
"name": "Kirk Lazarus",
"email": "kirk.lazarus@corvusgps.com",
"userType": "trackedUser",
"simPhoneNumber": "555-OPTIONAL"
}
{
"success": "User has been created successfully!",
"result": {
"1": {
"uid": 1,
"did": 1,
"name": "Kirk Lazarus",
"email": "kirk@corvusgps.com",
"userType": "trackedUser",
"loginLevel": "user",
"isActive": 1,
"country": "UK",
"timezone": "GMT+1",
"lastLoginTime": 1554854520,
"simPhoneNumber": "555-OPTIONAL",
"groupViewer": [],
"groupMember": []
}
},
"id": 1,
"resultCount": 1
}
List all your users
GET https://api.corvusgps.com/users/
{
"success": "Users have been retrieved successfully!",
"result": {
"1": {
"uid": 1,
"did": 1,
"device": {
"did": 1,
"name": "Josh",
"uniqueID": null,
"trackerID": "123456789024680",
"deviceType": "evertrack",
"deviceCategory": "trackedUser",
"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": []
},
"name": "Kirk Lazarus",
"email": "kirk@corvusgps.com",
"userType": "trackedUser",
"loginLevel": "user",
"isActive": 1,
"country": "UK",
"timezone": "GMT+1",
"lastLoginTime": 1554854520,
"simPhoneNumber": "555-OPTIONAL",
"groupViewer": [],
"groupMember": []
},
"2": {
"uid": 2,
"name": "Damien Cockburn",
"email": "damien@corvusgps.com",
"userType": "dispatcher",
"loginLevel": "user",
"isActive": 1,
"country": "UK",
"timezone": "GMT+1",
"lastLoginTime": 1554854520,
"simPhoneNumber": "555-OPTIONAL",
"groupViewer": [],
"groupMember": []
}
},
"resultCount": 1
List a specific user
GET https://api.corvusgps.com/users/1
{
"success": "User has been retrieved successfully!",
"result": {
"1": {
"uid": 1,
"did": 1,
"name": "Kirk Lazarus",
"email": "kirk@corvusgps.com",
"userType": "trackedUser",
"loginLevel": "user",
"isActive": 1,
"country": "UK",
"timezone": "GMT+1",
"lastLoginTime": 1554854520,
"simPhoneNumber": "555-OPTIONAL",
"groupViewer": [],
"groupMember": []
}
},
"resultCount": 1
Add group memberships
PUT https://api.corvusgps.com/v2/users/1/groupMember/1,2,3
{
"success": "Added group memberships successfully!",
"result": {
"1": {
"uid": 1,
"did": 1,
"name": "Kirk Lazarus",
"email": "kirk@corvusgps.com",
"userType": "trackedUser",
"loginLevel": "user",
"isActive": 1,
"country": "UK",
"timezone": "GMT+1",
"lastLoginTime": 1554854520,
"simPhoneNumber": "555-OPTIONAL",
"groupViewer": [
],
"groupMember": [
1,
2,
3
]
}
},
"resultCount": 1
}
Remove group memberships
DELETE https://api.corvusgps.com/v2/users/1/groupMember/1
{
"success": "Removed group memberships successfully!",
"result": {
"1": {
"uid": 1,
"did": 1,
"name": "Kirk Lazarus",
"email": "kirk@corvusgps.com",
"userType": "trackedUser",
"loginLevel": "user",
"isActive": 1,
"country": "UK",
"timezone": "GMT+1",
"lastLoginTime": 1554854520,
"simPhoneNumber": "555-OPTIONAL",
"groupViewer": [
],
"groupMember": [
2,
3
]
}
},
"resultCount": 1
}
Add group viewerships
PUT https://api.corvusgps.com/v2/users/1/groupViewer/1,2,3
{
"success": "Added group viewerships successfully!",
"result": {
"1": {
"uid": 1,
"did": 1,
"name": "Kirk Lazarus",
"email": "kirk@corvusgps.com",
"userType": "trackedUser",
"loginLevel": "user",
"isActive": 1,
"country": "UK",
"timezone": "GMT+1",
"lastLoginTime": 1554854520,
"simPhoneNumber": "555-OPTIONAL",
"groupViewer": [
1,
2,
3
],
"groupMember": []
}
},
"resultCount": 1
}
Remove group viewerships
DELETE https://api.corvusgps.com/v2/users/1/groupViewer/1
{
"success": "Removed group viewerships successfully!",
"result": {
"1": {
"uid": 1,
"did": 1,
"name": "Kirk Lazarus",
"email": "kirk@corvusgps.com",
"userType": "trackedUser",
"loginLevel": "user",
"isActive": 1,
"country": "UK",
"timezone": "GMT+1",
"lastLoginTime": 1554854520,
"simPhoneNumber": "555-OPTIONAL",
"groupViewer": [
2,
3
],
"groupMember": []
}
},
"resultCount": 1
}
Delete a User
DELETE https://api.corvusgps.com/v2/user/1
{
"success": "User has been deleted successfully!"
}