Get Available Custom Locations API

Require Authentication

This API is used to get available custom locations for the company based on combination of deviceID and token.

URL

api/manageassets/customlocations

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/categories?q=manu%202&o=manufacturerName

q «contains keyword that want to be looked for. Keyword will search locationName field only»
latmin «contains minimum latitude that want to be looked for. Should be used together with "latmax", "longmin", "longmax" parameter, and all of them should be numeric.»
latmax «contains maximum latitude that want to be looked for. Should be used together with "latmin", "longmin", "longmax" parameter, and all of them should be numeric.»
longmin «contains minimum longitude that want to be looked for. Should be used together with "latmin", "latmax", "longmax" parameter, and all of them should be numeric.»
longmax «contains maximum longitude that want to be looked for. Should be used together with "latmin", "latmax", "longmin" parameter, and all of them should be numeric.»
lat «contains latitude that want to be calculated to get the location, based on custom location coordinate and its radius. Should be used together with "long" parameter, and all of them should be numeric.»
long «contains longitude that want to be calculated to get the location, based on custom location coordinate and its radius. Should be used together with "lat" parameter, and all of them should be numeric.»
o «used to sort data, contains field name. Available value: locationName, createdDate, total_projectpins. Default value: locationName»
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=500&offset=0",
    "next_parameter": "",
    "previous_parameter": "",
    "start": 0,
    "total": 1,
    "lists": [{
      "customlocationID": 1,
      "locationName": "test location API",
      "locationAddress1": "",
      "locationAddress2": "",
      "locationCity": "",
      "locationState": "",
      "locationCountry": "",
      "locationPostCode": "",
      "locationLat": -6.202101230621,
      "locationLong": 106.77919006348,
      "locationRadius": 500,
      "createdDate": 1453481345,
      "createdByUserID": 3,
      "total_projectpins": 0
    }]
  }
}

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/manufacturer"+next_parameter or "api/manageassets/categories"+previous_parameter

Superfy Platform API Documentation