Get (just) all (deleted) Locations
GET/location/:type
Returns all Locations of the requested Company.
The "trashed" operation returns all Locations including deleted Locations.
The "justtrashed" operation returns only the deleted Locations.
Note, "normal" will yield the same result as without a type.
Also note, this excludes public Locations.
Request
Path Parameters
- "normal"
- Returns all the Locations except those which are deleted.
- "trashed"
- Returns all the Locations including those which are deleted.
- "justtrashed"
- Returns all and only the deleted Locations.
Possible values: [normal
, trashed
, justtrashed
]
Type of operations for querying deleted Locations.
Responses
- 200
- 403
- 404
Locations found.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
The guid of the Location
The guid of the Company of the Location.
Possible values: <= 255 characters
The name of the Location.
Possible values: <= 65535 characters
The description of the Location.
Possible values: <= 9999999999
The maximum capacity of people that can be at this Location. This number is strictly positive or 0 signaling an infinite capacity.
Possible values: >= -85
and <= 85
The latitude in LatLng format.
Possible values: >= -180
and <= 180
The longitude in LatLng format.
Possible values: <= 65536 characters
The address of this Location. This is free text, so it can be as large or small as desired.
Whether this Location should appear in the public listing.
The key of the seating chart. See Seats.io for more information.
The guid of the parent Location. In the case that the Location has a parent.
Whether the Location provides seating or not.
The time it was created.
The time it was last updated.
The time it was deleted.
[
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"capacity": 0,
"latitude": 0,
"longitude": 0,
"address": "string",
"public": true,
"seats_chart_key": "string",
"parent_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"seated": true,
"created_at": "string",
"updated_at": "string",
"deleted_at": "string"
}
]
Unauthorized. You do not have permission to manage the Locations of the Company.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
Company not found.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}