Check If Sensor Belongs to Company API
Require Authentication
This API is used to check if sensor is exist in system and belongs to company for the company based on combination of deviceID and token.
URL
api/sensors/validate
Required parameter (POST)
- deviceID
- token
- sensorstokenID «contains sensorstokenID. Value must be exist in database. To get the sensorstokenID, please see Get Available Sensor Manufacturers»
- sensorDeviceID «contains sensor device ID / serial number that want to be checked for.»
Optional parameter
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "2b6f3fc034d61fcbb75e52a9aab0c819",
"sensorstokenID": 3,
"sensorDeviceID": "aaaaaaaaaaaaaaab"
}
Possible return HTTP status code
- 200
- 400
- 401
- 403 if sensorDeviceID and sensorstokenID is registered to other customer.
- 404 if sensorDeviceID and sensorstokenID is not found
- 405
Return message, contains newly created asset category
{
"status": "success",
"message": {
"sensorsID": 479,
"sensorstokenID": 3,
"sensorCompany": "SmartsensorNew",
"sensorDeviceID": "aaaaaaaaaaaaaaab",
"firmwareVersion": "",
"sensorName": "SensorName",
"isAllocated": "Y",
"currentPinAllocated": {
"projectpinID": 1758,
"projectID": 152,
"projectName": "Zone 2",
"projectgroupID": 0,
"groupName": "",
"iconType": "pintype",
"iconID": 2,
"iconURL": "https://dashboard.superfy.com/assets/images/icons/default/appsize/enclosure.png",
"customlocationID": 0,
"locationName": "",
"pinAddress1": "",
"pinAddress2": "",
"pinCity": "",
"pinState": "",
"pinCountry": "",
"pinZipCode": "",
"latitude": -6.159944542411,
"longitude": 106.80634114891,
"name": "Designworks Test device",
"description": "",
"serialNumber": "",
"assetTag": [
{
"pinstagsID": 65,
"tags_text": "test tag param"
},
{
"pinstagsID": 69,
"tags_text": "Ualla"
}
],
"manufacturerID": 0,
"manufacturerName": "",
"createdDate": 1614829167,
"creatorUserID": 90,
"pinType": {
"pintypeID": 134,
"pinTypeName": "bb test",
"iconType": "system",
"iconID": 2,
"iconURL": "2",
"pinTypeDescription": "",
"pinTypeImageOriginalName": "",
"pinTypeImageURL": "",
"manufacturerID": 0,
"manufacturerName": "0",
"pinTypeCreatedDate": 1591353799,
"pinTypeCreatedByUserID": 90,
"pinTypeModifiedDate": 1614829214,
"pinTypeModifiedByUserID": 90,
"depthWhenEmpty_cm": 20,
"distanceSensorToFillLine_cm": 2,
"total_projectpins": 33
},
"depthWhenEmpty_cm": 20,
"distanceSensorToFillLine_cm": 2
},
"description": "",
"heartbeatFrequency": 0,
"companyID": 16,
"createdDate": 1557290069,
"updatedDate": 1692283763,
"createdByUserID": 5,
"updatedByUserID": 90,
"connectivityType": "LORAWAN AS923",
"simCardNumber": "",
"connectivityProvider": "Actility",
"latest_sensorsdata": {
"sensorsdataID": 21547633,
"sensorallocation": {
"projectpinID": 1758,
"projectID": 152,
"projectName": "Zone 2",
"projectgroupID": 0,
"groupName": "",
"iconType": "pintype",
"iconID": 2,
"iconURL": "https://dashboard.superfy.com/assets/images/icons/default/appsize/enclosure.png",
"customlocationID": 0,
"locationName": "",
"pinAddress1": "",
"pinAddress2": "",
"pinCity": "",
"pinState": "",
"pinCountry": "",
"pinZipCode": "",
"latitude": -6.159944542411,
"longitude": 106.80634114891,
"name": "Designworks Test device",
"description": "",
"serialNumber": "",
"assetTag": [
{
"pinstagsID": 65,
"tags_text": "test tag param"
},
{
"pinstagsID": 69,
"tags_text": "Ualla"
}
],
"manufacturerID": 0,
"manufacturerName": "",
"createdDate": 1614829167,
"creatorUserID": 90,
"pinType": {
"pintypeID": 134,
"pinTypeName": "bb test",
"iconType": "system",
"iconID": 2,
"iconURL": "2",
"pinTypeDescription": "",
"pinTypeImageOriginalName": "",
"pinTypeImageURL": "",
"manufacturerID": 0,
"manufacturerName": "0",
"pinTypeCreatedDate": 1591353799,
"pinTypeCreatedByUserID": 90,
"pinTypeModifiedDate": 1614829214,
"pinTypeModifiedByUserID": 90,
"depthWhenEmpty_cm": 20,
"distanceSensorToFillLine_cm": 2,
"total_projectpins": 33
},
"depthWhenEmpty_cm": 20,
"distanceSensorToFillLine_cm": 2
},
"sensorEventID": "",
"sensorDeviceID": "aaaaaaaaaaaaaaab",
"firmwareVersion": "",
"headerMethod": "heartbeat",
"reason": "SAMPLE_PERIOD",
"temperatureExist": "Y",
"temperatureValue": 720,
"temperatureOkay": "N",
"accelerometer_x": 0,
"accelerometer_y": 0,
"accelerometer_z": -0.649999976158,
"ultrasoundExist": "Y",
"ultrasound": 59,
"batteryLevel": 100,
"signalStrengthExist": "Y",
"signalStrength_rssi_dbm": -93,
"signalStrength_bitErrorRate": 0,
"laserDistance1": 112,
"laserDistance2": 118,
"averageDistance": 96,
"laserAverageDistance": 115,
"timestampdata": 1673881939
},
"fillLevelSource": "laseravg",
"sensorallocatedID": "3609"
}
}
Note:
"latest_sensorsdata" may have null value if there is no latest sensor data.
"currentPinAllocated", "latest_sensorsdata", and "sensorallocation" might be null if there is no data