Property Content

Properties/view

Method endpoint

http://{endpoint}/properties/view

Required parameters

property_id - the property whose details are being retrieved

Optional parameters

locale - the localisation you wish to retrieve data in, for example ‘en_GB’, ‘en’ or ’en_US’. Note that in the event there are no published localisations available, the system will attempt to fall back, e.g. from pt_BR to PT. Adding the optional region_fallback=1 parameter will ensure that content of en is returned if none exists

region_fallback - When requesting localised content, set this to the locale of the region to fallback to e.g. ‘en’ or ‘en_GB’, this does not affect ‘pt_BR’ falling back to ‘pt_PT’. If not set, and the specified locale has no content, then an empty dataset will be returned.

Result XML

Significant fields include:

hotels/rooms

Method endpoint

http://{endpoint}/hotels/rooms

Required parameters

property_id - the property whose room types are being retrieved

Optional parameters

locale - the localisation you wish to retrieve data in, for example ‘en_GB’, ‘en’ or ’en_US’. Note that in the event there are no published localisations available, the system will attempt to fall back, e.g. from pt_BR to PT. Adding the optional region_fallback=1 parameter will ensure that content of en is returned if none exists

region_fallback - When requesting localised content, set this to the locale of the region to fallback to e.g. ‘en’ or ‘en_GB’, this does not affect ‘pt_BR’ falling back to ‘pt_PT’. If not set, and the specified locale has no content, then an empty dataset will be returned.

Result XML

Significant fields include:

rates/types

Method endpoint

http://{endpoint}/rates/types

Required parameters

property_id - the property whose rate types are being retrieved

Result XML

Significant fields include:

offers

Method endpoint

http://{endpoint}/offers

Optional parameters

property_id - the property whose room types are being retrieved

Result XML

Significant fields include:

offers (cont.)

Method endpoint

http://{endpoint}/offers/byID

Required parameters

offer_id - the ID of the offer being retrieved (as seen in /nexus/search)

Result XML

Significant fields include:

properties/reviews

Method endpoint

http://{endpoint}/properties/reviews

Required parameters

property_id - the property whose reviews are being retrieved

Optional parameters

locale - the localisation you wish to retrieve data in, for example ‘en_GB’, ‘en’ or ’en_US’. Note that in the event there are no published localisations available, the system will attempt to fall back, e.g. from pt_BR to PT. Adding the optional region_fallback=1 parameter will ensure that content of en is returned if none exists

region_fallback - When requesting localised content, set this to the locale of the region to fallback to e.g. ‘en’ or ‘en_GB’, this does not affect ‘pt_BR’ falling back to ‘pt_PT’. If not set, and the specified locale has no content, then an empty dataset will be returned.

Result XML

Significant fields include: