Page Comparison

May obtain details, description, photos, … of a property calling the request inventory function.

Endpoint:

Status

colour	Green
title	get

https://ws.icnea.net/inventory_request.aspx

Use this API to retrieve a specific listing.

REQUEST

Code Block

language	xml

<inventory_request>
  <link>
    <user>integer(4)</user>
    <password>character(20)</password>
  </link>
  <lodging>
    <lodging_id>integer(8)</lodging_id>
  </lodging>
</inventory_request>

...

RESPONSE

Code Block

language	xml

<inventory_request_response>
  <lodging>
    <lodging_id>integer(8)</lodging_id>    
<lodging_action>add/update/cancel</lodging_action>
    <lodging_type>hotel/apartment/villa/hostel</lodging_type>
    <lodging_company_name>character(50)</lodging_company_name>
    <lodging_public_name>character(50)</lodging_public_name>
    <lodging_address>character(50)</lodging_address>
    <lodging_address_plus>characternumber>character(50)</lodging_address_plus>number>
    <lodging_address_city>characterstaircase>character(50)</lodging_address_city>staircase>
    <lodging_address_zip>characterfloor>character(50)</lodging_address_zip>floor>
    <lodging_country>iso3166 _address_door>character(50)</lodging_address_country>door>
    <lodging_address_region>charactertype>character(50)</lodging_address_region>type>    
    <lodging_telephone>characteraddress_plus>character(50)</lodging_telephone>address_plus>
    <lodging_email>charactercity>character(50)</lodging_email>city>
    <lodging_category>characterzip>character(50)</lodging_category>zip>
    <lodging_latitude>decimal<country>iso3166 </lodging_latitude>country>
    <lodging_longitude>decimal<region>character(50)</lodging_longitude>region>
    <lodging_maximum_capacity>integer telephone>character(50)</lodging_maximum_capacity>telephone>
    <lodging_surface>integer email>character(m250)</lodging_surface>email>
    <lodging_number_of_rooms>integer</lodging_number_of_rooms>category>character(50)</lodging_category>
    <lodging_latitude>decimal</lodging_latitude>
    <lodging_longitude>decimal</lodging_longitude>
    <lodging_surface>integer (m2)</lodging_surface>
    <lodging_standard_capacity>integer</lodging_standard_capacity>
    <lodging_maximum_capacity>integer</lodging_maximum_capacity>    
    <lodging_number_of_bathrooms>integer<rooms>integer</lodging_number_of_bathrooms>rooms>
    <lodging_number_of_single_beds>integer<bathrooms>integer</lodging_number_of_single_beds>bathrooms>
    <lodging_number_of_double_beds>integer<toilets>integer</lodging_number_of_double_toilets>
    <lodging_number_of_single_beds>integer</lodging_number_of_single_beds>
    <lodging_number_of_double_beds>integer</lodging_number_of_double_beds>
    <lodging_number_of_sofa_beds>integer</lodging_number_of_sofa_beds>
    <lodging_number_of_bunk_beds>integer</lodging_number_of_bunk_beds>
    <lodging_currency>EUR</lodging_currency>
    <lodging_distance_to_city_airport>decimalcentre>decimal(km)</lodging_distance_to_city_airport>centre>
    <lodging_distance_to_airport>decimal(km)</lodging_distance_to_airport>
    <lodging_distance_to_harbour>decimal(km)</lodging_distance_to_harbour>
    <lodging_distance_to_railway_station>decimal(km)</lodging_distance_to_railway_station>
    <lodging_distance_to_public_transport>decimal(km)</lodging_distance_to_public_transport>
    <lodging_distance_to_hospital>decimal(km)</lodging_distance_to_hospital>
    <lodging_distance_to_pharmacy>decimal(km)</lodging_distance_to_pharmacy>
    <lodging_distance_to_market>decimal(km)</lodging_distance_to_market>
    <lodging_distance_to_ski_slope>decimal(km)</lodging_distance_to_ski_slope>
    <lodging_distance_to_beach>decimal(km)</lodging_distance_to_beach>
    <lodging_distance_to_golf>decimal(km)</lodging_distance_to_golf>
    <lodging_distance_to_public_park>decimal(km)</lodging_distance_to_public_park>
    <lodging_distance_to_historic_district>decimal(km)</lodging_distance_to_historic_district>
    <lodging_distance_to_city_center>decimal(km)</lodging_distance_to_city_center>
    <lodging_legal_registration_number>character(50)</lodging_legal_registration_number>
    <lodging_cadastral_reference_number>character(50)</lodging_cadastral_reference_number>
    <lodging_booking_fee>decimal</lodging_booking_fee>
    <lodging_cleaning_fee>decimal</lodging_cleaning_fee>
    <lodging_booking_deposit>decimal</lodging_booking_deposit>
    <lodging_currency>EUR <_minimum_advance_reservation>integer</lodging_currency>
_minimum_advance_reservation>    <lodging_descriptions>
      <lodging_checkin_description>schedule>
      <checkin>
 <description_id>integer </description_id>         <language>iso639-1</language><from>integer</from>
        <headline>character(50)</headline><to>integer</to>
        <text>character(4000)</text><price>integer</price>
      </lodging_description>checkin>
    </lodging_descriptions>_checkin_schedule>    
    <lodging_checkout_images>schedule>
      <lodging_image><checkout>
        <image_url>character(50)</image_url><from>integer</from>
        <image_width>integer (pixels)</image_width><to>integer</to>
        <image_height>integer (pixels)</image_height><price>integer</price>
      </lodging_image>checkout>
    </lodging_checkout_images>schedule>    
<lodging_equipment>    <lodging_cancellation_policies>
  <elevator>true</elevator>    <lodging_cancellation_policy>
  <heating>true</heating>       <fan>true</fan><days_prior>integer</days_prior>
        <air<refund_conditioning>true<percentage>integer</airrefund_conditioning>percentage>
      <air_conditioning_in_living_room>true</air_conditioning_in_living_room></lodging_cancellation_policy>
    </lodging_cancellation_policies>  <bicycle_storage>true</bicycle_storage>  
    <parking_lot>true</parking_lot><lodging_terms_and_conditions>
      <covered<vacational_car_park>true</covered_car_park>rental_agreement>
      <free_car_park>true</free_car_park>  <language>iso639-1</language>
    <car_needed>true</car_needed>       <car_recommended>true</car_recommended><text>character(4000)</text>
      <car_not_needed>true</car_not_needed></vacational_rental_agreement>
      <swimming_pool>true</swimming_pool></lodging_terms_and_conditions>
    <lodging_descriptions>
 <private_swimming_pool>true</private_swimming_pool>     <lodging_description>
 <communal_swimming_pool>true</communal_swimming_pool>       <public_swimming_pool>true</public_swimming_pool><description_id>integer </description_id>
      <solarium>true</solarium>   <language>iso639-1</language>
   <garden>true</garden>     <headline>character(50)</headline>
 <gym>true</gym>       <sauna>true</sauna><text>character(4000)</text>
      <spa>true<</spa>lodging_description>
      <fireplace>true</fireplace></lodging_descriptions>
    <lodging_images>
 <playground>true</playground>     <lodging_image>
 <board_games>true</board_games>       <pool_table>true</pool_table><image_url>character(50)</image_url>
      <table_tennis>true</table_tennis>  <image_width>integer (pixels)</image_width>
        <futbolin>true</futbolin><image_height>integer (pixels)</image_height>
      <barbecue>true</barbecue>
 </lodging_image>
    </lodging_images>
    <farm_animals>true</farm_animals><lodging_equipment>
      <orchard>true</orchard>...
    </lodging_equipment>
    <lodging_services>
      <breakfast>true</breakfast>
...
     <restaurant>true</restaurant></lodging_services>
    <lodging_surroundings>
 <bar>true</bar>     ...
   <hairdresser>true</hairdresser> </lodging_surroundings>
    <lodging_location>
 <laundry>true</laundry>     ...
 <news_stand>true</news_stand>
    </lodging_location>
    <lodging_restrictions>
    <babysitting>true</babysitting>  ...
    <health_service>true<</healthlodging_service>restrictions>
      <massage_service>true</massage_service><lodging_recommendations>
      <reception>true</reception>...
      <front_desk_24h>true</front_desk_24h></lodging_recommendations>
      <room_service>true</room_service><lodging_cleaning_disinfection>
      <airport_transfer>true</airport_transfer>...
      <city_transfer>true</city_transfer></lodging_cleaning_disinfection>
    <lodging_accessibility>
  <business_center>true</business_center>    ...
    <left_luggage>true<</leftlodging_luggage>accessibility>
      <ski_lockers>true</ski_lockers><lodging_sustainability>
      <rent_a_car>true</rent_a_car>...
      <bycicle_rental>true</bycicle_rental></lodging_sustainability>
      <ski_rental>true</ski_rental><lodging_rooms>
      <snow_racket_rental>true</snow_racket_rental><lodging_room>
        <reading<room_room>true<id>integer </readingroom_room>id>
      <shopping>true</shopping>  <room_units>
    <florist>true</florist>       <meeting_rooms>true</meeting_rooms><unit_id>character(50)</unit_id>
          <game_room>true</game_room><unit_name>character(50)</unit_name>
        <dance_hall>true<</danceroom_hall>units>
      <discotheque>true</discotheque>  <room_descriptions>
    <casino>true</casino>      <room_description>
<bingo>true</bingo>     </lodging_services>     <lodging_surroundings>  <language>iso639-1</language>
     <tennis>true</tennis>       <horse_riding>true</horse_riding><text>character(1000)</text>
      <paddle>true</paddle>     </room_description>
 <golf>true</golf>       <mini_golf>true</mini_golf></room_descriptions>
        <pitch_and_putt>true</pitch_and_putt><room_images>
         <bowling>true</bowling> <room_image>
     <archery>true</archery>       <paintball>true</paintball><image_url>character(50)</image_url>
      <beach>true</beach>       <water_skiing>true</water_skiing><image_width>integer (pixels)</image_width>
        <scuba_diving>true</scuba_diving>    <image_height>integer (pixels)</image_height>
       <sailing>true</sailing>   </room_image>
   <surf>true</surf>     </room_images>  <windsurf>true</windsurf>      
<climbing>true</climbing>       <rockodrome>true</rockodrome> <room_equipment>
     <rock_climbing>true</rock_climbing>     ...
 <canyoning>true</canyoning>       <canoeing>true</canoeing></room_equipment>
       <rafting>true</rafting> <room_rates>
         <hiking>true</hiking> <room_rate>
     <speleology>true</speleology>       <via<rate_ferrata>true<id>integer</viarate_ferrata>id>
      <small_game_hunting>true</small_game_hunting>       <big_game_hunting>true</big_game_hunting><rate_persons>integer</rate_persons>       <fishing>true</fishing>     
 <hot_air_balloon>true</hot_air_balloon>       <paragliding>true</paragliding>    <rate_descriptions>
   <skydiving>true</skydiving>       <ultra_light_flight>true</ultra_light_flight>    <rate_description>
  <hang_glider>true</hang_glider>       <sailplane>true</sailplane>       <skiing>true</skiing><language>iso639-1</language>
         <nordic_skiing>true</nordic_skiing>       <ice_skating>true</ice_skating><text>character(50)</text>
        <mountain_walk>true</mountain_walk>       <bycicle_routes>true</bycicle_routes></rate_description>
      <wine_tourism>true</wine_tourism>       <romanic_route>true</romanic_route></rate_descriptions>
      <cistercian_monasteries>true</cistercian_monasteries>     </room_rate>
 <picking_mushrooms>true</picking_mushrooms>       <cinemas>true<</cinemas>room_rates>
      <theatres>true<</theatres>lodging_room>
      <museums>true</museums></lodging_rooms>
      <amusement_park>true</amusement_park><payments_schedule>
      <water_park>true</water_park><payment_schedule>
      <zoo>true</zoo>  <schedule>character(50)</schedule>
    <church>true</church>       <synagogue>true</synagogue><percentage>character(50)</percentage>
      <mosque>true</mosque> </payment_schedule>
    </lodgingpayments_surroundings>schedule>
    <lodging_location><reviews>
      <sea_views>true</sea_views><review>
        <mountain_views>true</mountain_views><date>yyyy-MM-dd</date>
        <lake_views>true</lake_views><language>iso639-1</language>
        <on_the_beachfront>true</on_the_beachfront><name>character(50)</name>
        <golf_course_view>true</golf_course_view><rating>decimal</rating>
       <in_the_old_town>true</in_the_old_town>
    </lodging_location> <comment>character(1000)</comment>
    <lodging_restrictions>  </review>
    <adults_only>true</adults_only></reviews>      
  <smoking_not_allowed>true</smoking_not_allowed>
      <animals_not_allowed>true</animals_not_allowed>
 </lodging>
</inventory_request_response>

Check-in and check-out schedule:

Code Block

language	xml

<lodging_checkin_schedule>
  <checkin>
    <parties_not_allowed>true</parties_not_allowed><from>integer</from>
    <to>integer</to>
 <hooligans_not_allowed>true</hooligans_not_allowed>   <price>integer</price>
   <not_adapted_for_disabled_guests>true</not_adapted_for_disabled_guests>
 </checkin>
</lodging_checkin_schedule>    
<lodging_checkout_schedule>
  <checkout>
    <bachelor_parties_not_allowed>true</bachelor_parties_not_allowed><from>integer</from>
      <youth_groups_not_allowed>true</youth_groups_not_allowed><to>integer</to>
    <price>integer</price>
  <no_parking_lot>true</no_parking_lot>
   </checkout>
</lodging_restrictions>
    <lodging_recommendations>checkout_schedule>       <handicapped_accessible>true</handicapped_accessible>
      <gay_friendly>true</gay_friendly>
      <family_friendly>true</family_friendly>
      <event_friendly>true</event_friendly >
      <smoker_friendly>true</smoker_friendly>
      <pets_accepted>true</pets_accepted>
    </lodging_recommendations>
    <cancellation_policies>
      <cancellation_policiy>
        <days_before_arrival>integer</days_before_arrival>
        <total_amount_percentage_fee>integer</total_amount_percentage_fee>
      </cancellation_policiy>
    </cancellation_policies>
    <checkin_checkout_times>
      <checkin_time>
        <checkin_time_from>integer</checkin_time_from>
        <checkin_time_to>integer</checkin_time_to>
        <checkin_fee>decimal</checkin_fee>
      </checkin_time>
      <checkout_time>
        <checkout_time_from>integer</checkout_time_from>
        <checkout_time_to>integer</checkout_time_to>
        <checkout_fee>decimal</checkout_fee>
      </checkout_time>
    </checkin_checkout_times>
    <lodging_rooms>
      <lodging_room>
        <room_id>integer </room_id>
        <room_name> character(20)</room_name>
        <room_units>
          <unit_id>character(50)</unit_id>
        </room_units>
        <room_descriptions>
          <room_description>
            <language>iso639-1</language>
            <text>character(1000)</text>
          </room_description>
        </room_descriptions>
        <room_images>
          <room_image>
            <image_url>character(50)</image_url>
            <image_width>integer (pixels)</image_width>
            <image_height>integer (pixels)</image_height>
          </room_image>
        </room_images>
        <room_rates>
          <room_rate>
            <rate_id>integer</rate_id>
            <rate_persons>integer</rate_persons>
            <rate_name> character(20)</rate_name>
            <rate_descriptions>
              <rate_description>
                <language>iso639-1</language>
                <text>character(50)</text>
              </rate_description>
            </rate_descriptions>
          </room_rate>
        </room_rates>
        <room_equipment>
          <terrace>true</terrace>
          <furnished_terrace>true</furnished_terrace>
          <balcony>true</balcony>
          <baby_cot>true</baby_cot>
          <high_chair>true</high_chair>
          <sun_loungers>true</sun_loungers>
          <bed_linen>true</bed_linen>
          <slippers>true</slippers>
          <bathrobe>true</bathrobe>
          <safety_box>true</safety_box>
          <fire_extinguisher>true</fire_extinguisher>
          <first_aid_kit>true</first_aid_kit>
          <smoke_detector>true</smoke_detector>
          <carbon_monoxide_detector>true</carbon_monoxide_detector>
          <mini_bar>true</mini_bar>
          <bathroom>true</bathroom>
          <shower>true</shower>
          <bathtub>true</bathtub>
          <hydromassage_bathtub>true</hydromassage_bathtub>
          <jacuzzi>true</jacuzzi>
          <hairdryer>true</hairdryer>
          <gel_and_shampoo>true</gel_and_shampoo>
          <towels>true</towels>
          <vacuum>true</vacuum>
          <washing_machine>true</washing_machine>
          <tumble_dryer>true</tumble_dryer>
          <clothesline>true</clothesline>
          <iron>true</iron>
          <iron_board>true</iron_board>
          <clothes_hangers>true</clothes_hangers>
          <kitchen>true</kitchen>
          <oven>true</oven>
          <microwave>true</microwave>
          <fridge>true</fridge>
          <freezer>true</freezer>
          <dishwasher>true</dishwasher>
          <coffee_maker>true</coffee_maker>
          <teapot>true</teapot>
          <kettle>true</kettle>
          <nespresso>true</nespresso>
          <dolcegusto>true</dolcegusto>
          <capsule_coffee_maker>true</capsule_coffee_maker>
          <toaster>true</toaster>
          <squeezer>true</squeezer>
          <food_mixer>true</food_mixer>
          <frying_pan>true</frying_pan>
          <dishes>true</dishes>
          <spice_selection>true</spice_selection>
          <tv>true</tv>
          <satellite_tv>true</satellite_tv>
          <tv_3d>true</tv_3d>
          <telephone>true</telephone>
          <internet>true</internet>
          <wifi>true</wifi>
          <free_wifi>true</free_wifi>
          <wifi_access_with_charge>true</wifi_access_with_charge>
          <battery_charger>true</battery_charger>
          <sound_system>true</sound_system>
          <dvd_player>true</dvd_player>
          <video_games>true</video_games>
        </room_equipment>
      </lodging_room>
    </lodging_rooms>
 </lodging>
</inventory_request_response>

There can be up to 3 check-in and check-out schedules.

The first one will always be free, with <price>0</price>. The other one or two can, and usually will have, a price.

Cancellation policies:

Code Block

language	xml

<lodging_cancellation_policy>
  <days_prior>integer</days_prior>
  <refund_percentage>integer</refund_percentage>
</lodging_cancellation_policy>

There can be up to 3 cancellation policies.

Terms and conditions / descriptions:

Code Block

language	xml

<vacational_rental_agreement>
  <language>iso639-1</language>
  <text>character(4000)</text>
</vacational_rental_agreement>

<lodging_description>
  <description_id>integer </description_id>
  <language>iso639-1</language>
  <headline>character(50)</headline>
  <text>character(4000)</text>
</lodging_description>

There will be as many nodes as languages in the PMS.

Images:

Code Block

language	xml

<lodging_image>
  <image_url>character(50)</image_url>
  <image_width>integer (pixels)</image_width>
  <image_height>integer (pixels)</image_height>
</lodging_image>

There can be up to 48 photos.

Each photo will be send in the biggest size.

The sizes can be: 2100x1575px, 1400x1050px or 700x525px.

Amenities:

Code Block

language	xml

<lodging_equipment>...</lodging_equipment>
<lodging_services>...</lodging_services>
<lodging_surroundings>...</lodging_surroundings>
<lodging_location>...</lodging_location>
<lodging_restrictions>...</lodging_restrictions>
<lodging_recommendations>...</lodging_recommendations>
<lodging_cleaning_disinfection>...</lodging_cleaning_disinfection>
<lodging_accessibility>...</lodging_accessibility>
<lodging_sustainability>...</lodging_sustainability>
<room_equipment>...</room_equipment>

The amenities will be a boolean true/false for each one.

The list of amenities for each category can be found here.

The <room_equipment> node is inside the <lodging_rooms> but, for vacation rentals properties, this will be the lodging equipment as well. It is separated in another node for the hotel property type.

Payment schedule:

Code Block

language	xml

<payment_schedule>
  <schedule>character(50)</schedule>
  <percentage>character(50)</percentage>
</payment_schedule>

There can be up to 3 payment schedule nodes.

The most usual configuration is 2 nodes: one at_booking and another at_checkin. But there are Property Managers that have a more flexible configuration.

The <schedule> options can be:

AT_BOOKING
X_DAYS_BEFORE_ARRIVAL → where X will be a number
AT_CHECKIN

Versions Compared

Old Version 2

New Version Current

Key

REQUEST

RESPONSE