Add employee to outlet

Request Details

Method Controller Resource Parameters
POST staff outlet_id user_id / access_level

Parameters Guide

Parameter Accepts
outlet_id int id of outlet as supplied by BeepXtra
user_id Accepts int internal id of user or string Valid Email
access_level int 1-4, 1=Super, 2=Store Admin, 3=manager, 4=cashier

Example Request Format

Direct Url https://api.beepxtra.com/staff/391/[email protected]/3
Curl CURL -A "YOURAPPNAME|1.0|AppID|AppKEY|staff" -X POST https://api.beepxtra.com/staff/391/[email protected]/3
PHP SDK $beepapi->request('post', 'staff', '391/[email protected]/3');

Sample Response

Success
{  
   "success":true,
   "request":{  
      "method":"POST",
      "controller":"staff",
      "resource":"548",
      "parameters":"\/staff\/548\/22\/3"
      "url_elements":[  
         "staff",
         "548",
         "22",
         "3"
      ]
   },
   "error":{  
      "errorid":0,
      "message":0
   },
   "data":{  
      "success":true
   }
}
Error
{  
   "success":false,
   "request":{  
      "method":"POST",
      "controller":"staff",
      "resource":"548",
      "parameters":"\/staff\/548\/user@email_com\/3"
      "url_elements":[  
         "staff",
         "548",
         "22",
         "3"
      ]
   },
   "error":{  
      "message":"User does not exist. Please register first",
      "errorid":305
   },
   "data":{  
      "error":"User does not exist. Please register first",
      "errorid":305,
      "errormsg":"User does not exist. Please register first"
   }
}

Response Guide

Parameter Type Details
error String Contains the error message returned
success boolean returns true id successful

Search

API Documentation