Lodging is a type of residential accommodation. It contains information such as: name, number of rooms, description, etc.
| Field | Type | Description |
|---|---|---|
| id | long | Lodging database unique identifier (used as REST identifier) |
| reference | String | Lodging human readable unique identifier (used as reference by customers) |
| city | String | City name where you can find the lodging |
| country | String | Two-letter country code (ISO) |
| latitude | Double | GPS latitude |
| longitude | Double | GPS longitude |
| standing | int | quality level (1to5) |
| surface | int | Surface area (m²) |
| rooms | int | Number of rooms |
| bathrooms | int | Number of bathrooms |
| bedrooms | int | Number of bedrooms |
| personMax | int | Maximum number of persons allowed into the lodging |
| geoTree | GeoTree | Region, area and city in which lodging is located |
| Description | Description | Description of the lodging |
| type | String | Lodging type (HOUSE or APARTMENT or BOAT_DOCKED or CAMPING) |
| subType | String | Lodging subType (STUDIO, APARTMENT, HOUSE, VILLA, CHALET, GITE, BUNGALOW, MOBILHOME, GUESTROOM), optional information |
| features | Features Enum List | Features available from the lodging (i.e barbecue, internet, ) |
| surroundings | Surrounding Enum List | Surroundings available next to the lodging (i.e sea, taxi, ) |
| photos | PoplidaysPhoto list | Lodging detail photos order by dimension desc |
| minWeekBasePrice | Double | Minimal price for a week without promotion (useful to display crossed out price) |
| minWeekPrice | Double | Minimal price for a week with promotion (if available). If no promotion is available, minWeekBasePrice and minWeekPrice are the same |
| minWeekPromotion | Double | Reduction available on minimal price for a week without promotion |
| mandatoryServicesPrice | Double | Sum of all mandatory extra services |
| priceEnabled | boolean | false means that price is only available through call center |
| caution | String | Caution of the lodging in euro or unknown value |
| requestOnly | boolean | true means that customer must contact call center to book |
| conciseShortLabel | String | Lodging label (ex: Apartment, 2 bedrooms, 5 pers.) |
| shortLabel | String | Lodging label (ex: Rental Apartment, 2 bedrooms, 5 persons) |
| conciseMediumLabel | String | Lodging label (ex: Apartment Hendaye, 2 bedrooms, 5 pers.) |
| mediumLabel | String | Lodging label (ex: Rental Apartment Hendaye, 2 bedrooms, 5 persons) |
| conciseLongLabel | String | Lodging label (ex: Apartment Hendaye, 2 bedrooms, 5 persons) |
| longLabel | String | Lodging label (ex: Rental Apartment Parcheteguia - Hendaye, 2 bedrooms, 5 persons) |
| url | String | Poplidays url of the lodging |
| lastChange | String | Last change of lodging (format: YYYY-MM-ddXXX) |
| carRequired | String | Lodings car required(EMPTY, RECOMMENDED_CAR, ADVISABLE_CAR, ALL_WALKING) |
| licenceAgreement | String | Licence agreement |
| licenceNumber | String | Registration Number |
| distanceLake | String | Represent the distance to a lake point. Possible value are :
|
| distanceBeach | String | Represent the distance to the sea. Possible value are :
|
| distanceSlope | String | Represent the distance to the slope. Possible value are :
|
| distanceCityCentre | String | Represent the distance to city center. Possible value are :
|
| distanceShops | String | Represent the distance to a commercial zone. Possible value are :
|
| distanceBus | String | Represent the distance to a bus stop. Possible value are :
|
| distanceMetro | String | Represent the distance to a metro. Possible value are :
|
| distanceTram | String | Represent the distance to a tram. Possible value are :
|
| distanceTaxi | String | Represent the distance to a taxi holding point. Possible value are :
|
| distanceToESF | String | Represent the distance to a ski school. Possible value are :
|
| extras | List of PoplidaysExtras | List of extra services available for the lodging. if present needs to verify the price with the API extras. |
| terms | Receptive terms | Arrival and departure information related to the lodging |
| roomDescriptions | RoomDescription | List of additional information per room |
| hasReview | Boolean | The lodging has One or more review |
| reviewDetail | ReviewDetail | Detail of the review for the property |
| countrySide | View | View from the main room of the |
| residence | String | Name of the residence of the lodging, if existing |
| residentialUsage | ResidentialUsage | Residential usage of the lodging. Possible value are :
|