Appearance
hotel
17 endpoints.
GET /api/v1/hotel/domains
List Domains
The PBX domains this caller may run a hotel on, with room counts.
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response List Domains Api V1 Hotel Domains Get"
}GET /api/v1/hotel/board
Board
Every room, its guest and its housekeeping state — the console's one read.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
domain | query | no |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Board Api V1 Hotel Board Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/hotel/extensions
Extensions
The extension picker, with the room already holding each one.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
domain | query | no |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Extensions Api V1 Hotel Extensions Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/hotel/rooms
Create Room
Request body
json
{
"properties": {
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"room_name": {
"type": "string",
"title": "Room Name"
},
"extension_uuid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Extension Uuid"
}
},
"type": "object",
"required": [
"room_name"
],
"title": "RoomIn"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Create Room Api V1 Hotel Rooms Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PATCH /api/v1/hotel/rooms/{room_uuid}
Update Room
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
room_uuid | path | yes | string |
Request body
json
{
"properties": {
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"room_name": {
"type": "string",
"title": "Room Name"
},
"extension_uuid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Extension Uuid"
}
},
"type": "object",
"required": [
"room_name"
],
"title": "RoomIn"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Update Room Api V1 Hotel Rooms Room Uuid Patch"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/hotel/rooms/{room_uuid}
Delete Room
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
room_uuid | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Delete Room Api V1 Hotel Rooms Room Uuid Delete"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/hotel/rooms/{room_uuid}/check-in
Check In
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
room_uuid | path | yes | string |
Request body
json
{
"properties": {
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Name"
},
"arrival": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Arrival"
},
"departure": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Departure"
},
"housekeeping_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Housekeeping Status"
}
},
"type": "object",
"title": "CheckInIn"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Check In Api V1 Hotel Rooms Room Uuid Check In Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/hotel/rooms/{room_uuid}/check-out
Check Out
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
room_uuid | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Check Out Api V1 Hotel Rooms Room Uuid Check Out Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/hotel/rooms/{room_uuid}/move
Move
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
room_uuid | path | yes | string |
Request body
json
{
"properties": {
"destination_uuid": {
"type": "string",
"title": "Destination Uuid"
}
},
"type": "object",
"required": [
"destination_uuid"
],
"title": "MoveIn"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Move Api V1 Hotel Rooms Room Uuid Move Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/hotel/rooms/{room_uuid}/housekeeping
Housekeeping
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
room_uuid | path | yes | string |
Request body
json
{
"properties": {
"code_uuid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Uuid"
}
},
"type": "object",
"title": "HousekeepingIn"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Housekeeping Api V1 Hotel Rooms Room Uuid Housekeeping Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/hotel/wakeups
List Wakeups
Every wake-up call still due on this hotel.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
domain | query | no |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response List Wakeups Api V1 Hotel Wakeups Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/hotel/rooms/{room_uuid}/wakeups
Schedule Wakeup
Set a wake-up call. The PBX's own dispatcher places it — see hotel_pbx's wake-up section for why none of that is duplicated here.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
room_uuid | path | yes | string |
Request body
json
{
"properties": {
"wake_at": {
"type": "string",
"format": "date-time",
"title": "Wake At"
},
"recurring": {
"type": "boolean",
"title": "Recurring",
"default": false
}
},
"type": "object",
"required": [
"wake_at"
],
"title": "WakeupIn"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Schedule Wakeup Api V1 Hotel Rooms Room Uuid Wakeups Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/hotel/wakeups/{wakeup_uuid}
Cancel Wakeup
Cancel a wake-up call.
Authorised against the alarm's OWN domain, resolved from the row — the same reason _room_domain exists: a uuid in the path carries no hotel with it.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
wakeup_uuid | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Cancel Wakeup Api V1 Hotel Wakeups Wakeup Uuid Delete"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/hotel/housekeeping-codes
List Codes
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
domain | query | no |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response List Codes Api V1 Hotel Housekeeping Codes Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/hotel/housekeeping-codes
Create Code
Request body
json
{
"properties": {
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"code": {
"type": "integer",
"title": "Code"
},
"label": {
"type": "string",
"title": "Label"
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": true
}
},
"type": "object",
"required": [
"code",
"label"
],
"title": "CodeIn"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Create Code Api V1 Hotel Housekeeping Codes Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PATCH /api/v1/hotel/housekeeping-codes/{code_uuid}
Update Code
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
code_uuid | path | yes | string |
Request body
json
{
"properties": {
"domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Domain"
},
"code": {
"type": "integer",
"title": "Code"
},
"label": {
"type": "string",
"title": "Label"
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": true
}
},
"type": "object",
"required": [
"code",
"label"
],
"title": "CodeIn"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Update Code Api V1 Hotel Housekeeping Codes Code Uuid Patch"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/hotel/housekeeping-codes/{code_uuid}
Delete Code
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
code_uuid | path | yes | string | |
domain | query | no |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Delete Code Api V1 Hotel Housekeeping Codes Code Uuid Delete"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}