ImmobiNet
ImmobiNet API Docs - Guests

Guests

​GuestsSummary
​object | null

Links for the guests to fill in their data online, one for each language of the installation: the key is the language code (as language of the contacts, e.g. it, en), the value the link in that language. The whole field is null if online check-in is not available, the reservation is deleted or the online check-in page cannot be opened for it, or if the API user is not allowed to see the link: it needs the anagrafica_personale_tutti privilege, because the link opens the customer's and guests' full data (it is null even when the guests' names are shown), and the checkin_online_vedi_link privilege. The page can stop opening over time (e.g. access blocked after arrival or departure) without the reservation changing, so a link read earlier may no longer work. Read it when needed, do not store it.

Example: {"it":"https://www.example.com/it/checkin/3f2c9a1e-0b7d-4c55-9a61-2d8e4b7a1c90/check/0a1b2c3d4e5f","en":"https://www.example.com/en/checkin/3f2c9a1e-0b7d-4c55-9a61-2d8e4b7a1c90/check/0a1b2c3d4e5f"}
​Guest[]

GuestsSummary

expected
​integer

Total number of people of the reservation.

registered
​integer

Number of guests registered.

complete
​integer

Number of registered guests with all the required data.

Guest

id
​integer
contact_id
​integer

Id of the guest's contact (see the Contacts API).

primary
​boolean

Primary guest (head of the group).

arrival
​string | null · date
departure
​string | null · date
complete
​boolean

true when all the data required for the guest are filled in.