Skip to content

Occupancy Format

From API version 0.10.x BETA and upward, our platform uses an easy way to express occupancy in a single string value. This format will be used for both API requests and responses. When multiple rooms are requested, the occupancies will be handled and referred to in sequential order.

ApiXV Occupancy Format String
Rooms delimited by | (pipe character), Pax delimited by - (dash character)

Format: [A/C[Age]]-[A/C[Age]]-...\|[A/C[Age]]-[A/C[Age]]-...
- A = Adult
- C = Child

Examples:

A-A-C0
One room, two adults, one infant.

A-A-C8
One room, two adults, one child of 8 years old.

A-A-C11-C15
One room, two adults, two children of 11 and 15 years old.

A-A-C9|A-C7-C4
Two rooms, first with two adults and one child of 9, second room with one adult and two children of 7 and 4.

Optional: Added Adult Ages

A29-A33-C14
One room, two adults of 29 and 33 (ages optional), one child of 14.

A67-A71
One room two seniors.

The letters used in this field are not case sensitive, hence a29-a33-c14 will also work

This API supports:

- Maximum number of rooms: 4
- Maximum Adults per room: 6
- Maximum Children per room: 5

Copyright ApiXV 2024 ©