Get Active Employees of Outlet

Request Details

Method Controller Resource Parameters
GET staff outlet outlet_id

Parameters Guide

Parameter Accepts
outlet_id int id of outlet as provided by BeepXtra

Example Request Format

Direct Url https://api.beepxtra.com/staff/outlet/391
Curl CURL -A "YOURAPPNAME|1.0|AppID|AppKEY|staff" -X GET https://api.beepxtra.com/staff/outlet/391
PHP SDK $beepapi->request('get', 'staff', 'outlet/391');

Sample Response

Success
{  
   "success":true,
   "request":{  
      "method":"GET",
      "controller":"staff",
      "resource":"outlet",
      "parameters":"\/staff\/outlet\/391",
      "url_elements":[  
         "staff",
         "outlet",
         "391"
      ]
   },
   "error":{  
      "errorid":0,
      "message":0
   },
   "data":[  
      {  
         "id":"50",
         "title":"Mr.",
         "name":"Angelos",
         "surname":"Hadjifilippou",
         "email":"[email protected]",
         "gender":"m",
         "user_type":"1",
         "type":"Administrator",
         "started":"2013-10-31 23:27:01"
      },
      {  
         "id":"65",
         "title":"Mr.",
         "name":"George",
         "surname":"Andrew",
         "email":"[email protected]",
         "gender":"m",
         "user_type":"3",
         "type":"Store Manager",
         "started":"2014-07-11 01:15:24"
      },
      {  
         "id":"35977",
         "title":"Mrs.",
         "name":"Constantina",
         "surname":"Christodoulou",
         "email":"[email protected]",
         "gender":"f",
         "user_type":"3",
         "type":"Store Manager",
         "started":"2014-09-03 10:02:48"
      },
      {  
         "id":"48",
         "title":"Ms.",
         "name":"Marios",
         "surname":"Agathokleous",
         "email":"[email protected]",
         "gender":"m",
         "user_type":"4",
         "type":"Store Cashier",
         "started":"2014-09-03 17:16:07"
      },
      {  
         "id":"35982",
         "title":"Mrs.",
         "name":"conina",
         "surname":"christ",
         "email":"[email protected]",
         "gender":"m",
         "user_type":"4",
         "type":"Store Cashier",
         "started":"2014-09-04 16:54:18"
      }
   ]
}
Error
{  
   "success":false,
   "request":{  
      "method":"GET",
      "controller":"staff",
      "resource":"outlet",
      "parameters":"\/staff\/outlet\/3991",
      "url_elements":[  
         "staff",
         "outlet",
         "3991"
      ]
   },
   "error":{  
      "message":"Invalid Store - Outlet ID specified",
      "errorid":308
   },
   "data":{  
      "error":"Invalid Store - Outlet ID specified",
      "errorid":308,
      "errormsg":"Invalid Store - Outlet ID specified"
   }
}

Response Guide

Parameter Type Details
error String Contains the error message returned
id bigint Global user id from database
title string title of card holder (e.g. Mr.)
name string First name of card holder
surname string Last name of card holder
email string Email address of employee
gender string enum m/f for Male or Female accordingly
user_type int 1 to 4 for access level, 1=Super, 2=Store Admin, 3=manager, 4=cashier
type string Type description of access level
started datetime Date/Time of the employee added to this outlet

Search

API Documentation