Skip to main content

User

Create a user.#

URL:https://api.lingaros.com/v1/lingapos/user

MethodTypeDescription
firstNameStringCustomer's first name.
lastNameStringCustomer's last name.
createdForStringStore id.
ownedByStringAccount id.
pinStringIPAD pin code.
firstScreenStringFirst screen which will be displayed when the user logs into IPAD.
clockINWhenPunchInBooleanCan treat user punch in time and punch out as clock in and out.
rolesStringEmployee roles.
languageStringEmployee 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.#

URL:https://api.lingaros.com/v1/lingapos/user/{user-id}

curl -X GET -H "apikey: generated-api-key" \
"https://api.lingaros.com/v1/lingapos/user/{user-id}"

Update a user.#

URL:https://api.lingaros.com/v1/lingapos/user

MethodTypeDescription
firstNameStringCustomer first name.
lastNameStringCustomer last name.
createdForStringStore id.
ownedByStringAccount id of the store which user belongs to.
pinStringUser login pin. If user logged in via IPAD, then instead of password, pin number can be used.
firstScreenStringFirst screen which will be displayed when the user logs into IPAD.
clockINWhenPunchInBoolCan treat user punch in time and punch out as clock in and out.
rolesStringEmployee roles.
languagebson.ObjectIDEmployee 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" \