Skip to content

Identifiers (UIDs)

ApiXV generates globally unique UID's to identify various entities in API requests and responses. These can be recognised by the _uid postfix. If multiple UID's can be supplied (for example when searching for multiple hotels) we refer to it with the _uids prefix. Multiple UID's in parameters can be supplied using comma separated notation (for example: hotel_uids=AXH-qCzrQmMQvRPa,AXH-qCzrQmMWriE7,AXH-qCzrQmTsywzN)

ApiXV UID's are encoded to be safe to use in URL's and therefore will only contain lowercase letters, uppercase letters, numbers and dash characters (a-zA-Z0-9-).

uid Description Example
hotel_uid Unique code assigned to each hotel AXH-C6HRPHgmFBk
option_uid Unique code assigned to a availability option of a particular hotel offer and room type AXO-qGGXTiLz1d3W6vXoc1Z
quote_uid Unique code assigned to a requested quote AXQ-MmU8mwQNoquB5BuKB8HSoCY4
booking_uid Unique code assigned to a created booking AXB-K3E8CvtRnoaf1MuejgJJndvuYTKMALtLksRVj
cancellation_uid Unique code assigned a booking cancellation AXC-YTKMALtLksRVj

ApiXV uid's must be regarded as temporary identifiers. This means UID's cannot be externally cached or stored for longer use. The underlying algorithm could change at any time during the BETA phase, causing all uid's to potentially change.

Copyright ApiXV 2024 ©