Update Sensor Allocation Settings from Asset API
Require Authentication
This API is used to Update Sensor Allocation Settings from Asset for the company based on combination of deviceID and token.
URL
api/sensors/updateallocation
Required parameter (POST)
- deviceID
- token
- sensorallocatedID «contains sensorallocatedID that want to be updated. Value must exist in database. To get available sensorallocatedID, please visit Get Available Pins on Map (Specific or All Zone) or Get Sensor Allocation History or related API»
Optional parameter
- depthWhenEmpty_cm «if passed, it will update its depthWhenEmpty_cm field. It should contains integer value of height of container from bottom to fill line or Fill Height (in centimeters). Minimum value is 1»
- distanceSensorToFillLine_cm «if passed, it will update its distanceSensorToFillLine_cm field. It should contains integer value of distance of sensor from top of fill line or Fill Gap (in centimeters)»
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "c43fa596e7916827106b591e2bb026cd",
"sensorallocatedID": 1,
"depthWhenEmpty_cm": 90,
"distanceSensorToFillLine_cm": 10
}
Possible return HTTP status code
- 200
- 400
- 401
- 405
Return message, contains the sensor allocation data with the updated information
{
"status": "success",
"message": {
"sensorallocatedID": 1,
"sensorsID": 1,
"projectpinID": 9,
"name": "test pin type API aedit",
"iconURL": "http://localhost/sswebdash/assets/images/icons/pins/appsize/32.png",
"latitude": -6.203551769257,
"longitude": 106.78137969971,
"allocationDate": 1462817660,
"depthWhenEmpty_cm": 90,
"distanceSensorToFillLine_cm": 10,
"endDate": 1463685439,
"companyID": 1
}
}