Get Available Manufacturers API

Require Authentication

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

URL

api/manageassets/manufacturer

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 manufacturerName field only»
o «used to sort data, contains field name. Available value: manufacturerName, createdDate, total_projectpins, total_pintypes. Default value: manufacturerName»
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": 3,
    "lists": [{
      "manufacturerID": 3,
      "manufacturerName": "manu1",
      "manufacturerAddress1": "",
      "manufacturerAddress2": "",
      "manufacturerCity": "",
      "manufacturerState": "",
      "manufacturerCountry": "",
      "manufacturerPostCode": "",
      "manufacturerWebsite": "",
      "manufacturerPhone": "",
      "manufacturerFax": "",
      "createdDate": 3,
      "createdByUserID": 1453203863,
      "total_pintypes": 1,
      "total_projectpins": 1
    }, {
      "manufacturerID": 2,
      "manufacturerName": "manu2",
      "manufacturerAddress1": "",
      "manufacturerAddress2": "",
      "manufacturerCity": "",
      "manufacturerState": "",
      "manufacturerCountry": "",
      "manufacturerPostCode": "",
      "manufacturerWebsite": "",
      "manufacturerPhone": "",
      "manufacturerFax": "",
      "createdDate": 3,
      "createdByUserID": 1452694870,
      "total_pintypes": 0,
      "total_projectpins": 1
    }, {
      "manufacturerID": 1,
      "manufacturerName": "Manufacturer API",
      "manufacturerAddress1": "",
      "manufacturerAddress2": "",
      "manufacturerCity": "",
      "manufacturerState": "",
      "manufacturerCountry": "",
      "manufacturerPostCode": "",
      "manufacturerWebsite": "",
      "manufacturerPhone": "",
      "manufacturerFax": "",
      "createdDate": 3,
      "createdByUserID": 1450176041,
      "total_pintypes": 2,
      "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/manufacturer"+previous_parameter

Superfy Platform API Documentation