Sensors Endpoint

You can list, modify and delete the sensors on your account.

Create a Sensor

POST https://api.corvusgps.com/v2/sensors/
{
    "name": "Josh's Ruuvi Tag",
    "uniqueID": "123abc321cba",
    "deviceType": "ruuvi",
    "simPhoneNumber": "555-OPTIONAL"

}
{
    "success": "Sensor has been created successfully!",
    "result": {
        "1": {
            "did": 1,
            "name": "Josh's Ruuvi Tag",
            "uniqueID": "123abc321cba",
            "trackerID": null,
            "deviceType": "ruuvi",
            "deviceCategory": "sensor",
            "isActive": 1,
            "guard": null,
            "humidity": 58.97,
            "airPressure": 1020,
            "temperature": 23.37,
            "lastBatteryLevel": 100,
            "lastGPSTimestamp": 1572756668,
            "lastKnownAddress": "Veterans Blvd, San Francisco, USA",
            "lastValidLatitude": 37.79926,
            "lastValidLongitude": -122.46953,
            "odometerKM": 6088.63,
            "groupMember": [
                1
            ]
        }
    },
    "id": 1,
    "resultCount": 1
}

List all your Sensors

GET https://api.corvusgps.com/v2/sensors/
{
    "success": "Sensors has been retrieved successfully!",
    "result": {
        "1": {
            "did": 1,
            "name": "Josh's Ruuvi Tag",
            "uniqueID": "123abc321cba",
            "trackerID": null,
            "deviceType": "ruuvi",
            "deviceCategory": "sensor",
            "isActive": 1,
            "guard": null,
            "humidity": 58.97,
            "airPressure": 1020,
            "temperature": 23.37,
            "lastBatteryLevel": 100,
            "lastGPSTimestamp": 1572756668,
            "lastKnownAddress": "Veterans Blvd, San Francisco, USA",
            "lastValidLatitude": 37.79926,
            "lastValidLongitude": -122.46953,
            "odometerKM": 6088.63,
            "groupMember": [
                1
            ]
        }
    },
    "resultCount": 1
}

List a specific Sensor Tag

by did (device ID)

GET https://api.corvusgps.com/v2/sensors/did/1

or by serial number if it has any

GET https://api.corvusgps.com/v2/sensors/uniqueID/0:1

or by IMEI/MEID if it has any

GET https://api.corvusgps.com/v2/sensors/trackerID/123456789024680
{
    "success": "Sensors retrieved successfully!",
    "result": {
        "1": {
            "did": 1,
            "name": "Bob's Inkbird",
            "uniqueID": "cba123abc321",
            "trackerID": null,
            "deviceType": "inkbird",
            "deviceCategory": "sensor",
            "isActive": 1,
            "guard": null,
            "humidity": 58.97,
            "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": [
                1
            ]
        }
    },
    "resultCount": 1
}

Modify a parameter

PATCH https://api.corvusgps.com/v2/sensors/did/1
{
    "name": "Bob's Temperature Sensor",
    "isActive": 1,
}
{
    "success": "Sensor has been successfully modified!",
    "result": {
        "1": {
            "did": 1,
            "name": "Bob's Temperature Sensor",
            "uniqueID": "cba123abc321",
            "trackerID": null,
            "deviceType": "inkbird",
            "deviceCategory": "sensor",
            "isActive": 1,
            "guard": null,
            "humidity": 58.97,
            "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": [
                1
            ]
        }
    },
    "resultCount": 1
}

Add the tag to group(s)

PUT https://api.corvusgps.com/v2/sensors/did/1/groupMember/2,3
{
    "success": "Group Memberships successfully modified!",
    "result": {
        "1": {
            "did": 1,
            "name": "Bob's Temperature Sensor",
            "uniqueID": "cba123abc321",
            "trackerID": null,
            "deviceType": "inkbird",
            "deviceCategory": "sensor",
            "isActive": 1,
            "guard": null,
            "humidity": 58.97,
            "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": [
                1,
                2,
                3
            ]
        }
    },
    "resultCount": 1
}

Remove the tag from group(s)

DELETE https://api.corvusgps.com/v2/sensors/did/1/groupMember/1
{
    "success": "Group Memberships successfully modified!",
    "result": {
        "1": {
            "did": 1,
            "name": "Bob's Temperature Sensor",
            "uniqueID": "cba123abc321",
            "trackerID": null,
            "deviceType": "inkbird",
            "deviceCategory": "sensor",
            "isActive": 1,
            "guard": null,
            "humidity": 58.97,
            "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 Sensor

DELETE https://api.corvusgps.com/v2/sensors/did/1
{
    "success": "Sensor has been deleted successfully!"
}