Job Positions
GET /locations/:locationId/job-positions
https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/job-positions
curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//job-positions' \
--header 'x-api-key;'
Retrieves all job positions for the supplied location.
Response Payload Structure
The response body for a "200 OK" response will contain a JSON array of job position objects. Each object in the array will be structured as follows:
Field Name | Field Type | Field Description | Org Level Attribute* |
---|---|---|---|
id | string | The unique ID for the job position. | Yes |
locationId | string | The unique ID for the location. | |
name | string | The name of the job position. | Yes |
deleted | boolean | True if the job position has been marked as deleted. | Yes |
- Note that the values of fields marked as "Org Level Attribute" are shared amongst all locations that reside in the same POS organization.
Example Reponse Payload
[
{
"id": "abc123",
"locationId": "LocationX",
"name": "Manager",
"deleted": false
}
]
Headers | |
---|---|
x-api-key | Your API Key |
Path Variables | |
---|---|
locationId | The unique ID for the location |
GET /locations/:locationId/job-positions/:jobPositionId
https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/job-positions/:jobPositionId
curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//job-positions/' \
--header 'x-api-key;'
Retrieves a single job position for the supplied location.
Response Payload Structure
The response body for a "200 OK" response will contain a single JSON job position object. See the parent route's documentation for more details.
Headers | |
---|---|
x-api-key | Your API Key |
Path Variables | |
---|---|
locationId | The unique ID for the location |
jobPositionId | The unique ID for the job position |
Updated over 2 years ago