...
The getPropertyInformation operation can be used to retrieve detailed information for a property or list of properties configured on the Allora IBE.
Request
Element | Type | Description |
siteIDList | Array | If provided, results will only be returned for the properties specified. If not provided, all properties enabled for your API user will be returned. |
channelIDList | Array | If provided, and the |
options | Array | Specify one or more of the available options to determine what information is returned in the response. List of Options |
...
| Code Block | ||
|---|---|---|
| ||
{
"userAuth": {
"username": "username",
"password": "password"
},
"operation": "getPropertyInformation",
"siteIDList": [
1853
],
"channelIDList": [
],
"options": [
]
} |
Options
Option | Description |
fullPropertyInformation | Property information including name, address, geolocation, facilities and other property configuration options. |
rateInformation | List of rates available on that property. Only rates on the specified channel are returned. |
roomInformation | List of rooms available on that property. |
rateGroupInformation | List of rate groups available on that property. Only rate groups with rates that are availabile on the channel specified are returned. |
taxPolicyInformation | List of tax policies configured for that property. Where a rate has a specific tax policy selected, the taxPolicyID will be included in the rate information Any rate that has a NULL taxPolicyID indicates pricing inclusive of all taxes and charges. |
imageInformation | Where you require the fully-resolved URLs for all property, rate or room imagery, this option must be included. This option adds a small performance overhead and should be used only if required. |
Response
Element | Type | Description | ||
siteList | Array | The siteList array will contain an entry for each site as requested in the siteIDList section of the request. | ||
siteID | Integer | The IBE siteID for the property. | ||
primaryName | String | Property name. | ||
address | String | Property address. | ||
phone | String | Property phone number. | ||
fax | String | Property fax number. | ||
url | String | Property website url. | ||
stars | Integer | Property star rating. | ||
currency | String | Property currency. | ||
portalShort | String | Property portal description. | ||
notificationEmail | String | Property primary notification email. | ||
acceptedCards | Array | Property accepted payment cards. | ||
timezone | String | Property timezone. | ||
earliestETA | String | Earlier checkin time. | ||
latestETA | String | Latest checkout time. | ||
cutoffTime | String | Latest cutoff time for same day bookings. | ||
facilities | Array | Array of facility codes available at the property. | ||
images | Array | Array of imageIDs used by the property. | ||
childPriceOptions | Array | Array of child price options. | ||
ageGroup | String | Identifier for this child price option in the Allora IBE. | ||
label | String | Label for this child price option. | ||
minAge | Integer | Minimun age for this child price option. | ||
maxAge | Integer | Maximum age for this child price option. | ||
geoLocation | Array | Geocoordinates for the property. | ||
latitude | String | Latitude coordinates. | ||
longitude | String | Longitude coordinates. | ||
portalURL | String | Portal URL for the property. |
...