Get Available System-default Icons API

Require Authentication

This API is used to get available system-default icons for the company based on combination of deviceID and token.

URL

api/manageassets/systemicons

Required parameter (POST)

deviceID
token

Optional parameter (GET)

All optional parameters use GET method. So it should be embedded in the URL, e.g: api/manageassets/systemicons?q=general%20pin&o=iconName

q «contains keyword that want to be looked for. Keyword will search iconName field only»
c «contains iconCategory that want to be looked for. Available value: pins, bins, arrows, numbers»
o «used to sort data, contains field name. Available value: iconName, total_projects, total_assettype, total_projectpins. Default value: iconName»
ot «used to sort data, contains sort type. Available value: asc, desc. Default value: asc»
per_page «indicates how many data that will be displayed in each call. Value must be a number between 1 to 500. Default value: 500»
offset «indicates the first data index that will be displayed in each call. Value must be a number with minimum value is 0. Default value: 0»

Example JSON Payload

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

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "current_parameter": "?per_page=999999999&offset=0",
    "next_parameter": "",
    "previous_parameter": "",
    "start": 0,
    "total": 4,
    "lists": [
      {
        "iconID": 31,
        "iconName": "Bigbelly",
        "iconDescription": "",
        "iconURL": "bigbelly.png",
        "iconCategory": "default",
        "defaultdepthWhenEmpty_cm": "0",
        "defaultdistanceSensorToFillLine_cm": "0",
        "total_projects": 0,
        "total_assettype": 0,
        "total_projectpins": 0,
        "iconURL_full": "https://wasteinsights-public-files.s3.ap-southeast-2.amazonaws.com/images/icons/default/appsize/bigbelly.png"
      },
      {
        "iconID": 4,
        "iconName": "Bigbelly Solar Compactor",
        "iconDescription": "",
        "iconURL": "bigbelly.png",
        "iconCategory": "default",
        "defaultdepthWhenEmpty_cm": "0",
        "defaultdistanceSensorToFillLine_cm": "0",
        "total_projects": 0,
        "total_assettype": 0,
        "total_projectpins": 1,
        "iconURL_full": "https://wasteinsights-public-files.s3.ap-southeast-2.amazonaws.com/images/icons/default/appsize/bigbelly.png"
      },
      {
        "iconID": 42,
        "iconName": "Black Bin",
        "iconDescription": "",
        "iconURL": "__Black - Recycling icon.png",
        "iconCategory": "bins",
        "defaultdepthWhenEmpty_cm": "0",
        "defaultdistanceSensorToFillLine_cm": "0",
        "total_projects": 0,
        "total_assettype": 0,
        "total_projectpins": 0,
        "iconURL_full": "https://wasteinsights-public-files.s3.ap-southeast-2.amazonaws.com/images/icons/bins/appsize/__Black - Recycling icon.png"
      },
      {
        "iconID": 35,
        "iconName": "Black Pin",
        "iconDescription": "",
        "iconURL": "38.png",
        "iconCategory": "pins",
        "defaultdepthWhenEmpty_cm": "0",
        "defaultdistanceSensorToFillLine_cm": "0",
        "total_projects": 0,
        "total_assettype": 1,
        "total_projectpins": 0,
        "iconURL_full": "https://wasteinsights-public-files.s3.ap-southeast-2.amazonaws.com/images/icons/pins/appsize/38.png"
      }
    ]
  }
}

Note: use "next_parameter" and "previous_parameter" to go to next or previous result page. Just combine it with the API URL, e.g: "api/manageassets/systemicons"+next_parameter or "api/manageassets/systemicons"+previous_parameter

Superfy Platform API Documentation