Allocate Sensor to Asset API
Require Authentication
This API is used to allocate specific sensor to asset for the company based on combination of deviceID and token.
URL
api/sensors/allocate
Required parameter (POST)
- deviceID
- token
- sensorsID «contains sensorsID that want to be allocated. sensorsID must be available or is not allocated to any other bin)»
- projectpinID «contains projectpinID that want to be allocated.»
- depthWhenEmpty_cm «contains integer value of height of container from bottom to fill line or Fill Height (in centimeters). Minimum value is 1»
- distanceSensorToFillLine_cm «contains integer value of distance of sensor from top of fill line or Fill Gap (in centimeters)»
- deallocatedOld «contains value "Y" or "N" to indicate whether to deallocate all sensors that are currently allocated to asset (projectpinID) before allocate this current sensor. "Y" to deallocate, "N" to keep.»
Optional parameter
Example JSON Payload
{
"deviceID": "ABCD-EFGH-IJKL-MNOP",
"token": "c43fa596e7916827106b591e2bb026cd",
"sensorsID": 1,
"projectpinID": 9,
"depthWhenEmpty_cm": 100,
"distanceSensorToFillLine_cm": 10,
"deallocatedOld": "Y"
}
Possible return HTTP status code
- 201
- 400
- 401
- 405
Return message
{
"status": "success",
"message": {
"sensorallocatedID": 6,
"sensorsID": 1,
"projectpinID": 9,
"name": "test pin type API a",
"iconURL": "http://localhost/sswebdash/assets/images/icons/pins/appsize/32.png",
"latitude": -6.201930522919,
"longitude": 106.780265808105,
"allocationDate": 1463685089,
"depthWhenEmpty_cm": 100,
"distanceSensorToFillLine_cm": 10,
"endDate": 0,
"companyID": 1
}
}