Get Available Groups API

Require Authentication

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

URL

api/projects/groups/: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/groups to get all groups from all zones). If passed, value must exist in database and it must be put in the URL, e.g: api/projects/groups/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 groups only. Value should exist in database. Usage example: api/projects/groups/?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 groupName field only»
o «used to sort data, contains field name. Available value: groupName, total_projectpins. Default value: groupName»
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": "?offset=0",
    "previous_parameter": "?offset=0",
    "start": 0,
    "total": 2,
    "lists": [{
      "projectgroupID": 1,
      "projectID": 1,
      "projectName": "TEst without icon in the kost",
      "groupName": "group 1",
      "createdDate": 1462715208,
      "updatedDate": 1462715208,
      "createdBy": 3,
      "updatedBy": 3,
      "companyID": 1,
      "total_projectpins": 10
    }, {
      "projectgroupID": 3,
      "projectID": 1,
      "projectName": "TEst without icon in the kost",
      "groupName": "Test Group API",
      "createdDate": 1462732975,
      "updatedDate": 1462732975,
      "createdBy": 3,
      "updatedBy": 3,
      "companyID": 1,
      "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/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.

Superfy Platform API Documentation