Superfy Platform API Documentation

Get Specific Asset Fullness Level Filter in Company API

Require Authentication

This API is used to Get All Asset Fullness Level specifically used for Zone Explorer for the company based on combination of deviceID and token.

URL

api/companies/binlevelsfilter

Required parameter (POST)

Optional parameter (GET)

Example JSON Payload

{
  "deviceID": "ABCD-EFGH-IJKL-MNOP",
  "token": "c43fa596e7916827106b591e2bb026cd"
}

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "lists": [{
      "min": -9999,
      "max": -9999,
      "color": "b3b3b3",
      "text": "no data"
    }, {
      "min": -9999,
      "max": 50,
      "color": "39B54A",
      "text": "< 50%"
    }, {
      "min": 50,
      "max": 80,
      "color": "eb9b00",
      "text": "50 - 80%"
    }, {
      "min": 80,
      "max": -9999,
      "color": "f64040",
      "text": "80% ++"
    }]
  }
}

Note:
If min or max is -9999, it means that there is no range on that level.