Get Available Pins on Map (Specific or All Zone) API

Require Authentication

This API is used to get available pins on map (specific or all project) for the company based on combination of deviceID and token.

URL

api/projects/pins/:projectID

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/projects/pins/1?q=tes&o=name

:projectID «contains specific projectID that want to be looked for. Or leave blank (do not pass it, so just use api/projects/pins to get all pins from all projects). If passed, value must exist in database and it must be put in the URL, e.g: api/projects/pins/1. To get available projectID, please visit Get Available Zones»
ps «contains projectID in array format that want to be looked for. Should be used together with empty :projectID, otherwise it will get the :projectID pins only. Value should exist in database. Usage example: api/projects/pins/?ps[]=1&ps[]=2. To get available projectID, please visit Get Available Zones»
q «contains keyword that want to be looked for. Keyword will search name field only»
m «contains manufacturerID that want to be looked for. It will search manufacturerID field only. To get the manufacturerID, please see Get Available Manufacturers»
sn «contains serialNumber that want to be looked for. It will search serialNumber field only»
pt «contains pintypeID that want to be looked for. Value should be exist in database. To get the pintypeID, please see Get Available Asset Types»
pts «contains pintypeID in array format that want to be looked for. Value should be exist in database. To get the pintypeID, please see Get Available Asset Types. Usage example: api/projects/pins/1?pts[]=10&pts[]=9»
pg «contains projectgroupID that want to be looked for. Value should be exist in database. To get the projectgroupID, please see Get Available Groups»
pgs «contains projectgroupID in array format that want to be looked for. Value should be exist in database. To get the projectgroupID, please see Get Available Groups. Usage example: api/projects/pins/1?pgs[]=10&pgs[]=9»
tag «contains pinstagsID that want to be looked for. Value should be exist in database. To get the pinstagsID, please see Get Available Tags»
tags «contains pinstagsID in array format that want to be looked for. Value should be exist in database. To get the pinstagsID, please see Get Available Tags. Usage example: api/projects/pins/1?tags[]=10&tags[]=9»
fl «contains value of asset fullness level in array format or string with comma separated that want to be looked for. Value should have "-" (minus) sign to separate min and max range. The format should be: [min range]-[max range]. Usage example: api/projects/pins/1?fl[]=10-30&fl[]=50-70»
latmin «contains minimum latitude that want to be looked for.»
latmax «contains maximum latitude that want to be looked for.»
longmin «contains minimum longitude that want to be looked for.»
longmax «contains maximum longitude that want to be looked for.»
o «used to sort data, contains field name. Available value: name, assetTag, serialNumber, latitude, longitude, latest_timestampdata, latest_filllevel. Default value: pinTypeName»
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: none (unlimited result)»
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": "?offset=0",
    "next_parameter": "",
    "previous_parameter": "",
    "start": 0,
    "total": 1,
    "lists": [
      {
        "projectpinID": 6946,
        "projectID": 341,
        "projectName": "TestZone",
        "projectgroupID": 0,
        "groupName": "",
        "iconType": "pintype",
        "iconID": 2,
        "iconURL": "https://dashboard.superfy.com/assets/images/icons/default/appsize/enclosure.png",
        "iconName": "Enclosure Bin",
        "customlocationID": 0,
        "locationName": "",
        "pinAddress1": "",
        "pinAddress2": "",
        "pinCity": "",
        "pinState": "",
        "pinCountry": "",
        "pinZipCode": "",
        "latitude": 53.349281434148,
        "longitude": -6.268064498901,
        "name": "Dublin clone 3",
        "description": "",
        "serialNumber": "",
        "assetTag": [],
        "manufacturerID": 0,
        "manufacturerName": "",
        "createdDate": 1640870177,
        "creatorUserID": 90,
        "pinType": {
          "pintypeID": 134,
          "pinTypeName": "bb test",
          "depthWhenEmpty_cm": 98,
          "distanceSensorToFillLine_cm": 18
        },
        "currentAllocatedSensor": [
          {
              "sensorallocatedID": 4135,
              "sensorsID": 6071,
              "sensorstokenID": 3,
              "sensorCompany": "SmartsensorNew",
              "sensorDeviceID": "TAOGLAS CLONE SENSOR 3",
              "firmwareVersion": "",
              "sensorName": "Taoglas clone sensor 3",
              "description": "",
              "allocationDate": 1640870344,
              "depthWhenEmpty_cm": 98,
              "distanceSensorToFillLine_cm": 18,
              "endDate": 0,
              "installedOnSite": "N",
              "AssetSerial1": "",
              "AssetSerial2": "",
              "latestSensorDataDate": 1671140524,
              "latestSensorData": {
                  "gpsLat": "53.349281311035",
                  "gpsLon": "-6.268064498901",
                  "sensorDeviceID": "TAOGLAS CLONE SENSOR 3",
                  "temperatureExist": "Y",
                  "temperatureValue": 23.4,
                  "temperatureOkay": "Y",
                  "accelerometer_x": -11.279999732971,
                  "accelerometer_y": 12.720000267029,
                  "accelerometer_z": -60.279998779297,
                  "ultrasoundExist": "Y",
                  "ultrasound": 5000,
                  "laserDistance1": 0,
                  "laserDistance2": 0,
                  "laserAverageDistance": 0,
                  "averageDistance": 1666,
                  "ultrasoundFillLevel": "-4983",
                  "laserDistance1FillLevel": "118",
                  "laserDistance2FillLevel": "118",
                  "laserAverageFillLevel": "118",
                  "averageFillLevel": "-1581",
                  "batteryLevel": 66,
                  "signalStrengthExist": "N",
                  "signalStrength_rssi_dbm": 0,
                  "signalStrength_bitErrorRate": 0,
                  "timestampdata": 1671140524
              }
          }
        ],
        "vendorID": null,
        "installedOnSite": "N"
      }
    ]
  }
}

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/projects/pins/1"+next_parameter or "api/projects/pins/1"+previous_parameter
Since customlocationID is optional, if customlocationID is set to 0 and locationName is set to empty string, it indicates that asset type does not have custom location assigned.
Since manufacturerID is optional, if manufacturerID is set to 0 and manufacturerName is set to empty string, it indicates that asset type does not have manufacturer assigned.
currentAllocatedSensor has been sorted by latestSensorDataDate desc.
latestSensorData will contain 1 latest sensor data. But if the latest sensor data ultrasoundExist = 'N', it will find update the ultrasoundExist and ultrasound field with latest ultrasound success data reading, it will do the same for temperatureExist and temperatureValue, signalStrengthExist and signalStrength_rssi_dbm and signalStrength_bitErrorRate

Superfy Platform API Documentation