User
Create a user.
| Method | Type | Description |
|---|---|---|
| firstName | String | Customer's first name. |
| lastName | String | Customer's last name. |
| createdFor | String | Store id. |
| ownedBy | String | Account id. |
| pin | String | IPAD pin code. |
| firstScreen | String | First screen which will be displayed when the user logs into IPAD. |
| clockINWhenPunchIn | Boolean | Can treat user punch in time and punch out as clock in and out. |
| roles | String | Employee roles. |
| language | String | Employee language id. |
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"firstName": "Test",
"lastName": "Test",
"createdFor": "{store-id}",
"ownedBy": "{account-id}",
"pin": "0000",
"firstScreen": "pos",
"clockInWhenPunchIn": true,
"roles": [
"{role-id}"
],
"language": "{language-id}"
}' \
"https://api.lingaros.com/v1/lingapos/user" \
firstScreen options:
`toTable(Table Screen)`
`pos(POS Screen)`
`bar(Bar Service)`
`retail(Retail Screen)`
You can find role id at roles tab.
You can find language id at others tab.
Read all users by store.
URL:https://api.lingaros.com/v1/lingapos/store/{store-id}/users
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/store/{store-id}/users"
Read a user by ID.
curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/user/{user-id}"
Update a user.
| Method | Type | Description |
|---|---|---|
| firstName | String | Customer first name. |
| lastName | String | Customer last name. |
| createdFor | String | Store id. |
| ownedBy | String | Account id of the store which user belongs to. |
| pin | String | User login pin. If user logged in via IPAD, then instead of password, pin number can be used. |
| firstScreen | String | First screen which will be displayed when the user logs into IPAD. |
| clockINWhenPunchIn | Bool | Can treat user punch in time and punch out as clock in and out. |
| roles | String | Employee roles. |
| language | bson.ObjectID | Employee language id. |
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"firstName": "Test",
"lastName": "Test",
"createdFor": "{store-id}",
"ownedBy": "{account-id}",
"pin": "0000",
"firstScreen": "pos",
"clockInWhenPunchIn": true,
"roles": [
"{role-id}"
],
"language": "{language-id}"
}' \
"https://api.lingaros.com/v1/lingapos/user" \
Delete(Inactivate) a user.
URL:https://api.lingaros.com/v1/lingapos/user/{user-id}/inactivate
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
"https://api.lingaros.com/v1/lingapos/user/{user-id}/inactivate" \