Common objects
These are JSON object definitions and other JSON entities shared by operations across the API.
Time interval
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Start of the interval in UTC timezone in ISO 8601 format (see Datetimes). |
| string | required | End of the interval in UTC timezone in ISO 8601 format (see Datetimes). |
String update value
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | Value which is to be updated. |
Bool update value
Property | Type | Contract | Description |
---|---|---|---|
| boolean | optional | Value which is to be updated. |
Number update value
Property | Type | Contract | Description |
---|---|---|---|
| number | optional | Value which is to be updated. |
Integer update value
Property | Type | Contract | Description |
---|---|---|---|
| integer | optional | Value which is to be updated. |
Array of strings update value
Property | Type | Contract | Description |
---|---|---|---|
| array of strings | optional | Value which is to be updated. |
Dictionary
Dictionary is a collection of key-value pairs, where both keys and values are strings.
Property | Type | Contract | Description |
---|---|---|---|
?Key? | string | optional | Some value corresponding to the ?Key? unique identifier. Cannot be null. |
Dictionary of integers
Dictionary of integers is a collection of key-value pairs, where keys are strings and the values are arrays of integer.
Property | Type | Contract | Description |
---|---|---|---|
?Key? | array of integer | optional | A set of integer values corresponding to the ?Key? unique identifier. Cannot be null. |
Activity state
Active
- indicates active record.Deleted
- indicates deleted record.
Localized text
A Dictionary object where the keys are Language codes and the corresponding values are versions of the text in the respective language. For example:
Profile data
Property | Type | Contract | Description |
---|---|---|---|
| required | Type of the profile data. | |
| optional | Enterprise profile data. |
Profile data discriminator
Personal
Enterprise
Platform
Static
Integration
Enterprise profile data
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the profile. |
Amount
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO-4217 code of the Currency. |
| number | required | Net value without taxes. |
| number | required | Gross value including all taxes. |
| array of Tax value | required | The tax values applied. |
| required | Information about individual tax amounts. |
Tax value
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | Code corresponding to tax type. |
| number | required | Amount of tax applied. |
Tax breakdown
Property | Type | Contract | Description |
---|---|---|---|
| array of Tax breakdown item | required | Tax breakdown items per each tax rate applied. |
Tax breakdown item
Property | Type | Contract | Description |
---|---|---|---|
| string | optional | Tax rate code for the item. |
| number | required | The net value that the tax is calculated from. |
| number | required | The value of the tax. |
Currency value (ver 2018-06-07)
Usage of this value is deprecated. Where possible, use the properties exposing the Amount instead.
Property | Type | Contract | Description |
---|---|---|---|
| string | required | ISO-4217 code of the |
| number | optional | Amount in the currency. |
|
|
| Deprecated! |
|
|
| Deprecated! |
|
|
| Deprecated! |
Currency value (ver 2023-02-02)
Property | Type | Contract | Description |
---|---|---|---|
| string | required | |
| number | required |
Resource Feature Classification
SeaView
RiverView
OceanView
TwinBeds
DoubleBed
RollawayBed
UpperBed
LowerBed
Balcony
AccessibleBathroom
AccessibleRoom
ElevatorAccess
HighFloor
Kitchenette
AirConditioning
PrivateJacuzzi
PrivateSauna
EnsuiteRoom
PrivateBathroom
SharedBathroom
Activity State
Deleted
Active
Last updated