GET /v2/stays/search
Returns relevant stays that match a specified query and parameters (date, features, …).
Resource information
| Authentication | yes |
| Response Formats | xml, json |
| HTTP Method | GET |
| Response Object | Stay search result |
| API Version | v2 |
Resource parameters
| Query Parameter | Type | Mandory | Description |
|---|---|---|---|
| pagesize | int | Yes | Number of elements to display in one page |
| pageindex | int | Yes | Index of desired page |
| q | String | No | The search query |
| arrival | String | No | Stay arrival (format: "YYYYMMDD") |
| departure | String | No | Stay departure (format: "YYYYMMDD") |
| type | String | No | Type of lodgings. Available values are:
|
| pax | Integer | No | Number of desired person |
| standing | Integer | No | Quality number of lodgings (from 1 to 5) |
| promotions | List<String> | No | Lists of promotional codes |
| promotiononly | boolean | No | If this parameter is set to true, stays without promotion are filtered |
| maxprice | int | No | Maximum price |
| minprice | int | No | Minimum price |
| features | list<String> | No | List of desired features for the stay (i.e barbecue, television, …) |
| surroundings | list<String> | No | List of desired surroundings (i.e golf, sea, …) |
| sort | String | No | Kind of sort. Available values are:
|
Example Response
json
{
"total": 1,
"stays": [
{
"id": "20130328-20130404",
"arrival": "20130328",
"departure": "20130404",
"basePrice": 263,
"price": 263,
"promotion": 0,
"priceEnabled":true,
"requestOnly":false,
"lodging": {
"id": 886,
"reference": "FR-1-2-41",
"city": "Hendaye",
"surface": 0,
"rooms": 3,
"personMax": 5,
"standing": 0,
"features": [
"PETS",
"BALCONY",
"HEATING",
"FREEZER",
"SHOWER",
"OVEN",
"SMOKER",
"WASHINGMACHINE",
"MICROWAVE",
"TELEVISION",
"SEPARATETOILET"
],
"type": "APARTMENT",
"description": "Country apartment. Located on No. 2 floor, without elevator, in complex, simply furnished. Living room double sofa bed. Open kitchen with hotplates. 1 room(s) with double 140 bed(s) 1 bedroom(s) located on n°1 floor with small 90 bed. Room with WC and mezzanine.",
"photo": {
"pictures": [
{
"url": "https://api.poplidays.com/v2/pictures/156352-255x197.jpg",
"dimension": "255x197"
},
{
"url": "https://api.poplidays.com/v2/pictures/156352-395x304.jpg",
"dimension": "395x304"
},
{
"url": "https://api.poplidays.com/v2/pictures/156352-158x121.jpg",
"dimension": "158x121"
},
{
"url": "https://api.poplidays.com/v2/pictures/156352-478x368.jpg",
"dimension": "478x368"
},
{
"url": "https://api.poplidays.com/v2/pictures/156352-170x130.jpg",
"dimension": "170x130"
},
{
"url": "https://api.poplidays.com/v2/pictures/156352-440x340.jpg",
"dimension": "440x340"
},
{
"url": "https://api.poplidays.com/v2/pictures/156352-100x80.jpg",
"dimension": "100x80"
},
{
"url": "https://api.poplidays.com/v2/pictures/156352-375x258.jpg",
"dimension": "375x258"
}
]
},
"conciseShortLabel": "Apartment, 2 bedrooms, 5 pers.",
"shortLabel": "Rental Apartment, 2 bedrooms, 5 persons",
"conciseMediumLabel": "Apartment Hendaye, 2 bedrooms, 5 pers.",
"mediumLabel": "Rental Apartment Hendaye, 2 bedrooms, 5 persons",
"conciseLongLabel": "Apartment Hendaye, 2 bedrooms, 5 persons",
"longLabel": "Rental Apartment Parcheteguia - Hendaye, 2 bedrooms, 5 persons",
"url": "http://www.poplidays.com/en/product/886"
}
}
]
}
xml
<?xml version="1.0" encoding="UTF-8"?>
<searchresult>
<stays>
<stay>
<id>20130328-20130404</id>
<arrival>20130328</arrival>
<departure>20130404</departure>
<basePrice>263.0</basePrice>
<price>263.0</price>
<promotion>0</promotion>
<priceEnabled>true</priceEnabled>
<requestOnly>false</requestOnly>
<lodging>
<id>886</id>
<reference>FR-1-2-41</reference>
<city>Hendaye</city>
<surface>0</surface>
<rooms>3</rooms>
<personMax>5</personMax>
<standing>0</standing>
<features>
<feature>PETS</feature>
<feature>BALCONY</feature>
<feature>HEATING</feature>
<feature>FREEZER</feature>
<feature>SHOWER</feature>
<feature>OVEN</feature>
<feature>SMOKER</feature>
<feature>WASHINGMACHINE</feature>
<feature>MICROWAVE</feature>
<feature>TELEVISION</feature>
<feature>SEPARATETOILET</feature>
</features>
<type>APARTMENT</type>
<description>Country apartment. Located on No. 2 floor, without elevator, in complex, simply furnished. Living room double sofa bed. Open kitchen with hotplates. 1 room(s) with double 140 bed(s) 1 bedroom(s) located on n°1 floor with small 90 bed. Room with WC and mezzanine.</description>
<photo>
<pictures>
<picture>
<dimension>255x197</dimension>
<url>https://api.poplidays.com/v2/pictures/156352-255x197.jpg</url>
</picture>
<picture>
<dimension>395x304</dimension>
<url>https://api.poplidays.com/v2/pictures/156352-395x304.jpg</url>
</picture>
<picture>
<dimension>158x121</dimension>
<url>https://api.poplidays.com/v2/pictures/156352-158x121.jpg</url>
</picture>
<picture>
<dimension>478x368</dimension>
<url>https://api.poplidays.com/v2/pictures/156352-478x368.jpg</url>
</picture>
<picture>
<dimension>170x130</dimension>
<url>https://api.poplidays.com/v2/pictures/156352-170x130.jpg</url>
</picture>
<picture>
<dimension>440x340</dimension>
<url>https://api.poplidays.com/v2/pictures/156352-440x340.jpg</url>
</picture>
<picture>
<dimension>100x80</dimension>
<url>https://api.poplidays.com/v2/pictures/156352-100x80.jpg</url>
</picture>
<picture>
<dimension>375x258</dimension>
<url>https://api.poplidays.com/v2/pictures/156352-375x258.jpg</url>
</picture>
</pictures>
</photo>
<conciseShortLabel>Apartment, 2 bedrooms, 5 pers.</conciseShortLabel>
<shortLabel>Rental Apartment, 2 bedrooms, 5 persons</shortLabel>
<conciseMediumLabel>Apartment Hendaye, 2 bedrooms, 5 pers.</conciseMediumLabel>
<mediumLabel>Rental Apartment Hendaye, 2 bedrooms, 5 persons</mediumLabel>
<conciseLongLabel>Apartment Hendaye, 2 bedrooms, 5 persons</conciseLongLabel>
<longLabel>Rental Apartment Parcheteguia - Hendaye, 2 bedrooms, 5 persons</longLabel>
<url>http://www.poplidays.com/en/product/886</url>
</lodging>
</stay>
</stays>
<total>1</total>
</searchresult>