Get Property List
Returns a list of properties that are available to book including location, contact details and images.
Request Profile Table
| Element | @Attribute |
Description/Contents |
| GetPropertyList_RQ |
Root element of message. |
| SupplierID |
ID of the supplier (ie the property) to get details for. Set to 0 to return all
available properties |
Scenario:
You want to retrieve info for a property. The SupplierID is "100".
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetPropertyList_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SupplierID xmlns="ResLink">100</SupplierID>
</GetPropertyList_RQ>
Response Profile Table
| Element | @Attribute |
Description/Contents |
| GetPropertyList_RS |
Root element of message. |
| PropertyList |
Collection of Property objects |
| Property |
Object representing a single Property |
| @SupplierId |
The Supplier ID of the Property |
| @PropertyId |
The Id of the Property in the external PMS |
| @Name |
The Name of the Property |
| @MinNights |
Minimum number of nights for a booking at the Property |
| @MaxNights |
Maximum number of nights for a booking at the Property |
| @InterfaceType |
Indicates the external PMS used for fetching availability. Valid values are [None | Charts | HostelWorld] |
| Description |
A detailed description of the Property |
| Conditions |
Standard Terms and Conditions for the Property |
| Address |
The Address of the Property |
| Line1 |
Address Lines 1-3 of the Property |
| Line2 |
| Line3 |
| PostCode |
The PostCode of the Property |
| State |
The State of the Property |
| @Code |
State Code |
| @Name |
State Name |
| Country |
The Country of the Property |
| @Code |
Country Code |
| @Name |
Country Name |
| ContactList |
Collection of Contacts for the Property |
| Contact |
Object representing a single Contact |
| @Type |
Contact Type. Valid values are [Phone | Fax | Email] |
| @Description |
Description of Contact Type |
| @Value |
Contact Value, for Phone and Fax contacts a phone number, for Email the Email Address |
| Images |
Collection of Images for the Property |
| Image |
Object representing a single Image |
| @Description |
Description of the image |
| @Url |
Url of the image |
| PaymentMethods |
Collection of valid Payment Methods for the Property |
| PaymentMethod |
Object representing a single PaymentMethod |
| @Code |
Code of the Payment Method |
| @Name |
Name of the Payment Method |
Example message:
<?xml version="1.0" encoding="utf-8"?>
<GetPropertyList_RS>
<PropertyList>
<Property SupplierId="100" PropertyId="TESTPROPERTY" Name="Test Property" MinNights="1" MaxNights="14" InterfaceType="Charts">
<Description>The Test Property is an exciting place to stay. We have our own bar and a huge pool area.</Description>
<Conditions>Checkout 10am, no refunds</Conditions>
<Address>
<Line1>1 Test St</Line1>
<Line3>Testville</Line3>
<PostCode>400</PostCode>
<State Code="QLD" Name="Queensland" />
<Country Code="AUS" Name="Australia" />
</Address>
<ContactList>
<Contact Type="PHONE" Description="Phone1" Value="1800TESTER" />
<Contact Type="EMAIL" Description="Email" Value="test@example.org" />
</ContactList>
<Images>
<Image Description="Test Property Pool" Url="http://...." />
<Image Description="Test Property Bar" Url="http://...." />
</Images>
<PaymentMethods>
<PaymentMethod Code="CC" Name="Credit Card" />
</PaymentMethods>
</Property>
</PropertyList>
<TimeStamp>2013-02-22T10:58:04.6924032+10:00</TimeStamp>
<Status Code="0" Message="Success" />
<Errors />
<Warnings />
</GetPropertyList_RS>