Employee - POST
Stability: 2 - Stable
Helps to update employees.
The endpoint you need to use for this is:
/employee
Request
| Key |
Details |
Example |
| Authorization* |
{token_type} {access_token} |
Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f |
| Method* |
POST |
POST |
| x-accept-version |
{recommended_latest_version_number} |
0.5 |
* Required header
Body
NOTE: To update just supply the object id.
| Key |
Details |
Data Type |
| employees[{objectRef}].id |
Unique shopwave Identifier of an employees |
int |
| employees[{objectRef}].roleId |
Role of the employee. Check the Employee Role table for more information. |
int |
| employees[{objectRef}].joinedDate |
YYYY-MM-DD HH:ii:ss format of employee joined date. |
datetime |
| employees[{objectRef}].exitDate |
YYYY-MM-DD HH:ii:ss format of employee exit date. |
datetime |
Response
| Key |
Details |
Data Type |
Example |
| statusCode |
Very important to check this for any error. 201 for success. |
int |
201 |
Body
| Key |
Data Type |
Details |
| employees[{objectRef}].id |
Unique shopwave Identifier of an employees |
int |
| employees[{objectRef}].roleId |
Role of the employee. Check the Employee Role table for more information. |
int |
| employees[{objectRef}].joinedDate |
YYYY-MM-DD HH:ii:ss format of employee joined date. |
datetime |
| employees[{objectRef}].exitDate |
YYYY-MM-DD HH:ii:ss format of employee exit date. |
datetime |
Attribute Options
Role Id
| ID |
Value |
| 1 |
Owner |
| 2 |
Manager |
| 3 |
Assistant |
| 4 |
Guest |
| 5 |
Assistant Manager |
Status Codes
Error
Please check the live API calls for more details on the API messages.
| ID |
Status Code |
Title |
Details |
| 908 |
401 |
Expired Token |
Token expired or invalid. Please renew your token |
| 911 |
401 |
Authorization Header Invalid |
The authorization header is invalid. The correct format is Authorization: {token_type} {accessToken} |
| 910 |
404 |
Not Found |
The resource you are looking for does not exist |
| 899 |
500 |
Unknown Error |
Something went wrong. Please contact the site administrator |
| 913 |
400 |
Required parameter or object missing in request |
One or more of the required parameters or object formation is missing in your request. Please refer the documentation |
| 919 |
429 |
Cannot handle too many request |
There is a limit for every object you can send to our server and you are exceding that. |
Success
Please check the live API calls for more info on the API messages.
| ID |
Status Code |
Title |
Details |
| 206 |
201 |
Resource Created |
Your resource is created partially or fully. Please check further message or process log |
| 202 |
200 |
Token is valid |
Token is validated and found valid. |
//Employees is an object which should hold one or more employee object
//Object reference for each employee object. If there is an error check objectRef in API message.
//Id of employee
//roleId of an employee
//employee joined date
//employee exit date