Creating a user POST
Adding a role POST
List of users GET User Details GET GET Deleting User DELETE
Selecting a location POST
Selecting a desk POST
Clearing selected desk DELETE
Getting selected lines GET
Selecting line POST
Deselecting line DELETE
Adding profile picture to user POST
Deleting profile picture of user DELETE
/users
Creates a new user.
Request
curl -X POST https://api.qminder.com/v1/users
-H "X-Qminder-REST-API-Key: KEY"
Request parameter | Type | Description |
---|---|---|
String, Mandatory | Unique valid email address | |
firstName | String, Mandatory | First name |
lastName | String, Mandatory | Last name |
roles | JSON array, Mandatory | Array of user roles. User has to have at least one role . All fields have following parameters:
|
Response
{
"statusCode": 200,
"id": "226859"
}
Response field | Type | Description |
---|---|---|
id | Number | A unique ID of a created user |
/users/
id /roles
Adds a new role for a existing user.
Request
curl -X POST https://api.qminder.com/v1/users/3425/roles -d "type=MANAGER" -d "location=4255" -H "X-Qminder-REST-API-Key: KEY"
Request parameter | Type | Description |
---|---|---|
type | String, Mandatory | "CLERK", "MANAGER" or "ADMINISTRATOR" |
location | Number | ID of a location. Mandatory when "type" is "CLERK" or "MANAGER". Has no effect when "type" is "ADMINISTRATOR". |
Response
{
"statusCode": 200
}
/locations/
id /users
Get list of users for specified location.
Request
curl https://api.qminder.com/v1/locations/4052/users -H "X-Qminder-REST-API-Key: KEY"
Response
{
"statusCode": 200,
"data": [
{...},
{...}
]
}
Returns a list of users which are wrapped in a data object.
/users/
id Get details of a user by user id.
Request
curl https://api.qminder.com/v1/users/342 -H "X-Qminder-REST-API-Key: KEY"
Response
Returns a user.
/users/
email Get details of a user by email address (needs to be an exact match).
Request
curl https://api.qminder.com/v1/users/user@example.com -H "X-Qminder-REST-API-Key: KEY"
Response
Returns a user.
/users/
id Deletes the user.
Request
curl -X DELETE https://api.qminder.com/v1/users/458 -H "X-Qminder-REST-API-Key: KEY"
Response
{
"statusCode": 200
}
/users/
id /location
Selects a location.
Request
curl -X POST https://api.qminder.com/v1/users/3425/location \ -d "location=6543" \ -H "X-Qminder-REST-API-Key: KEY"
Request parameter | Type | Description |
---|---|---|
location | Number | ID of a location. |
Response
{
"statusCode": 200
}
/users/
id /desk
Selects a desk.
Request
curl -X POST https://api.qminder.com/v1/users/3425/desk \ -d "desk=12643" \ -H "X-Qminder-REST-API-Key: KEY"
Request parameter | Type | Description |
---|---|---|
desk | Number | ID of a desk in users currently selected location. |
Response
{
"statusCode": 200
}
/users/
id /desk
Removes users association with any desks.
Request
curl -X DELETE https://api.qminder.com/v1/users/458/desk \ -H "X-Qminder-REST-API-Key: KEY"
Response
{
"statusCode": 200
}
/users/
id /lines
Returns lines selected by user in a selected location.
Request
curl https://api.qminder.com/v1/users/458/lines \ -H "X-Qminder-REST-API-Key: KEY"
Response
{
"statusCode": 200,
"selectedLines":[2342, 4245, 3214]
}
/users/
id /lines/
lineid Selects line in currently selected location.
Request
curl -X POST https://api.qminder.com/v1/users/458/lines/4245 \ -H "X-Qminder-REST-API-Key: KEY"
Response
{
"statusCode": 200
}
/users/
id /lines/
lineid Deselects line in currently selected location.
Request
curl -X DELETE https://api.qminder.com/v1/users/458/lines/4245 \ -H "X-Qminder-REST-API-Key: KEY"
Response
{
"statusCode": 200
}
/users/
id /picture
Adds a profile picture to the user.
Request
curl -X POST https://api.qminder.com/v1/users/458/picture -H "X-Qminder-REST-API-Key: KEY" -H "Content-Type: image/jpeg" --data-binary "@path_to_picture/picture.jpg"
Response
{
"statusCode": 200
}
/users/
id /picture
Deletes the profile picture of the user.
Request
curl -X DELETE https://api.qminder.com/v1/users/458/picture -H "X-Qminder-REST-API-Key: KEY"
Response
{
"statusCode": 200
}