Get Available Users in Company API

Require Authentication

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

Only users that have module "user_and_roles_menu" in their role/department (currently only Administrator) can view user list

URL

api/companies/users

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/companies/department?q=username%20name&o=firstName&d=1

q «contains keyword that want to be looked for. Keyword will search firstName, lastName, and username field»
a «to filter users by "active" field. Possible value: "Y", "N"»
d «contains departmentID that want to be looked for. To get departmentID, please see Get Available Departments / Roles»
o «used to sort data, contains field name. Available value: firstName, lastName, username, departmentName. Default value: firstName»
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": 2,
    "lists": [{
      "userID": 3,
      "username": "indr4_winata@yahoo.com",
      "firstName": "Indra",
      "lastName": "Winata",
      "phone": 2147483647,
      "mobile": 2147483647,
      "profilePicture": "http:\/\/localhost\/mapmybins\/assets\/uploads\/profilepicture\/3\/68fc3555f3f8b1a5de5b6dacf5e4c3dc.jpg",
      "createdDate": 1446208931,
      "active": "Y",
      "timezoneOffset": 420,
      "timezoneName": "Asia/Jakarta",
      "isEmailVerified": "Y",
      "departmentID": 1,
      "departmentName": "Administrator"
    }, {
      "userID": 6,
      "username": "test@test.com",
      "firstName": "Test",
      "lastName": "API",
      "phone": 1234567890,
      "mobile": 1234567890,
      "profilePicture": "http:\/\/localhost\/mapmybins\/assets\/uploads\/profilepicture\/6\/68fc3555f3f8b1a5de5b6dacf5e4c3dc.jpg",
      "createdDate": 1449322266,
      "active": "Y",
      "timezoneOffset": 0,
      "timezoneName": "",
      "isEmailVerified": "Y",
      "departmentID": 2,
      "departmentName": "department from api"
    }]
  }
}

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/companies/users"+next_parameter or "api/companies/users"+previous_parameter

Note:
"timezoneOffset" contains user time differences to UTC in minutes. For example, if it is 420, it means that it is UTC +7 hour (420 minutes / 60 minutes × 1 hour = 7 hour)
"timezoneName" contains user timezone name as mentioned in http://php.net/manual/en/timezones.php

Superfy Platform API Documentation