Get Property Availability
Retrieve availability for the specified Property between a date range.
Request Profile Table
| Element | @Attribute |
Description/Contents |
| GetPropertyAvailability_RQ |
Root element of message. |
| SupplierID |
ID of the supplier (ie the property) to get details for |
| DateFrom |
Start date of the date range to search for |
| DateTo |
End date of the date range to search for |
| Guests |
Number of guests to seach for |
| Agent |
Element representing the agent.
To specify an agent you can just provide either the ID, or the GUID. If both are provided ResLink will make a check to see if the GUID and ID match in the database and will error if they don't. |
| @ID |
(optional) The agent ID to set up commissions and costs. |
| @GUID |
(optional) The agent GUID to set up commissions and costs |
| RoomTypeId |
(optional) RoomType Id to filter search availability. If not specified then all available RoomTypes are returned |
Scenario:
You want to retrieve availability for a property between 1/3/13 and 3/3/13 for 2 guests. The SupplierID is "100", the Agent is TEST_AGENT and no RoomTypeId is specified (returns all available RoomTypes)
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetPropertyAvailability_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SupplierID xmlns="ResLink">100</SupplierID>
<DateFrom xmlns="ResLink">2013-03-01T00:00:00</DateFrom>
<DateTo xmlns="ResLink">2013-03-03T00:00:00</DateTo>
<Guests xmlns="ResLink">2</Guests>
<Agent xmlns="ResLink" ID="" GUID="TEST_AGENT" />
<RoomTypeId xmlns="ResLink"/>
</GetPropertyAvailability_RQ>
Response Profile Table
| Element | @Attribute |
Description/Contents |
| GetPropertyAvailability_RS |
Root element of message. |
| PropertyAvailabilities |
Collection of PropertyAvailability objects |
| PropertyAvailability |
Object representing Availability as a result of a single AvailabilityQuery |
| @PropertyId |
Id of the Property in the external PMS |
| @PackageId |
(optional) Id of the Package if specified in Request |
| RoomTypeAvailabilities |
Collection of RoomTypeAvailabilities objects |
| RoomTypeAvailability |
Object representing a single type of room and it’s associated availability |
| @RoomTypeId |
Id of the RoomType |
| @Name |
Name of the RoomType |
| @MinCapacity |
Minimum Capacity for the room |
| @MaxCapacity |
Maximum Capacity for the room |
| @ComponentID |
ID of the Package component used for the RoomType in the ResLink Package Service |
| Description |
A detailed description of the RoomType |
| Images |
Collection of Images for the RoomType |
| Image |
Object representing a single Image |
| @Description |
Description of the image |
| @Url |
Url of the image |
| Availability |
Collection of RoomAvailability objects |
| RoomAvailability |
Object representing availability for a single RoomType at a single Property for a single Date |
| @Date |
Date of availability |
| @Price |
Price per night |
| @Commission |
Commission per night |
| @Currency |
Currency code for Price/Commission |
| @Available |
Number of instances of the RoomType that is available |
| @MinNights |
Minimum number of nights for a booking of the RoomType |
| @MaxNights |
Maximum number of nights for a booking of the RoomType |
| @CTA |
Closed To Arrival - indicates if bookings for this RoomType can not start on this date |
| @CTD |
Closed To Departure - indicates if bookings for this RoomType can not finish on this date |
Example message:
<GetPropertyAvailability_RS xmlns="ResLink">
<PropertyAvailabilities>
<PropertyAvailability PropertyId="TESTPROPERTY">
<RoomTypeAvailabilities>
<RoomTypeAvailability RoomTypeId="6SH" Name="6 Share Ensuite" MinCapacity="1" MaxCapacity="1" ComponentID="112">
<Description>6 Share Dorm Ensuite</Description>
<Images>
<Image Description="6 Share Enst" Url="http://...." />
</Images>
<Availability>
<RoomAvailability Date="2013-03-01T00:00:00" Price="28.00" Commission="2.800" Currency="AUD" Available="11" MinNights="0" MaxNights="0" PtsMulti="2" CTA="false" CTD="false" />
<RoomAvailability Date="2013-03-02T00:00:00" Price="28.00" Commission="2.800" Currency="AUD" Available="18" MinNights="0" MaxNights="0" PtsMulti="2" CTA="false" CTD="false" />
</Availability>
</RoomTypeAvailability>
<RoomTypeAvailability RoomTypeId="8SH" Name="8 Share Ensuite" MinCapacity="1" MaxCapacity="1" ComponentID="113">
<Description>8 Share Dorm Ensuite</Description>
<Images>
<Image Description="8 Share Enst" Url="http://...." />
</Images>
<Availability>
<RoomAvailability Date="2013-03-01T00:00:00" Price="30.00" Commission="3.000" Currency="AUD" Available="39" MinNights="0" MaxNights="0" PtsMulti="2" CTA="false" CTD="false" />
<RoomAvailability Date="2013-03-02T00:00:00" Price="30.00" Commission="3.000" Currency="AUD" Available="54" MinNights="0" MaxNights="0" PtsMulti="2" CTA="false" CTD="false" />
</Availability>
</RoomTypeAvailability>
<RoomTypeAvailability RoomTypeId="8SHF" Name="8 Share Female Ensuite" MinCapacity="1" MaxCapacity="1" ComponentID="114">
<Description>8 Share Female Dorm Ensuite</Description>
<Images />
<Availability>
<RoomAvailability Date="2013-02-01T00:00:00" Price="30.00" Commission="3.000" Currency="AUD" Available="0" MinNights="0" MaxNights="0" PtsMulti="2" CTA="false" CTD="false" />
<RoomAvailability Date="2013-02-02T00:00:00" Price="30.00" Commission="3.000" Currency="AUD" Available="5" MinNights="0" MaxNights="0" PtsMulti="2" CTA="false" CTD="false" />
</Availability>
</RoomTypeAvailability>
<RoomTypeAvailability RoomTypeId="KING" Name="King Room" MinCapacity="1" MaxCapacity="2" ComponentID="116">
<Description>King Room Ensuite</Description>
<Images>
<Image Description="King Room" Url="http://...." />
</Images>
<Availability>
<RoomAvailability Date="2013-02-01T00:00:00" Price="88.00" Commission="8.800" Currency="AUD" Available="2" MinNights="0" MaxNights="0" PtsMulti="2" CTA="false" CTD="false" />
<RoomAvailability Date="2013-02-02T00:00:00" Price="88.00" Commission="8.800" Currency="AUD" Available="0" MinNights="0" MaxNights="0" PtsMulti="0" CTA="false" CTD="false" />
</Availability>
</RoomTypeAvailability>
</RoomTypeAvailabilities>
</PropertyAvailability>
</PropertyAvailabilities>
<TimeStamp>2013-02-21T00:00:39.4841744+10:00</TimeStamp>
<Status Code="0" Message="" />
<Errors />
<Warnings />
</GetPropertyAvailability_RS>