Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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

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

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

Response:

<inventory_request_response>
  <lodging>
    <lodging_id>integer(8)</lodging_id>    
    <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_number>character(50)</lodging_address_number>
    <lodging_address_staircase>character(50)</lodging_address_staircase>
    <lodging_address_floor>character(50)</lodging_address_floor>
    <lodging_address_door>character(50)</lodging_address_door>
    <lodging_address_type>character(50)</lodging_address_type>    
    <lodging_address_plus>character(50)</lodging_address_plus>
    <lodging_city>character(50)</lodging_city>
    <lodging_zip>character(50)</lodging_zip>
    <lodging_country>iso3166 </lodging_country>
    <lodging_region>character(50)</lodging_region>
    <lodging_telephone>character(50)</lodging_telephone>
    <lodging_email>character(50)</lodging_email>
    <lodging_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_rooms>integer</lodging_number_of_rooms>
    <lodging_number_of_bathrooms>integer</lodging_number_of_bathrooms>
    <lodging_number_of_toilets>integer</lodging_number_of_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_centre>decimal(km)</lodging_distance_to_city_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_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_minimum_advance_reservation>integer</lodging_minimum_advance_reservation>    
    <lodging_checkin_schedule>
      <checkin>
        <from>integer</from>
        <to>integer</to>
        <price>integer</price>
      </checkin>
    </lodging_checkin_schedule>    
    <lodging_checkout_schedule>
      <checkout>
        <from>integer</from>
        <to>integer</to>
        <price>integer</price>
      </checkout>
    </lodging_checkout_schedule>    
    <lodging_cancellation_policies>
      <lodging_cancellation_policy>
        <days_prior>integer</days_prior>
        <refund_percentage>integer</refund_percentage>
      </lodging_cancellation_policy>
    </lodging_cancellation_policies>    
    <lodging_terms_and_conditions>
      <vacational_rental_agreement>
        <language>iso639-1</language>
        <text>character(4000)</text>
      </vacational_rental_agreement>
    </lodging_terms_and_conditions>
    <lodging_descriptions>
      <lodging_description>
        <description_id>integer </description_id>
        <language>iso639-1</language>
        <headline>character(50)</headline>
        <text>character(4000)</text>
      </lodging_description>
    </lodging_descriptions>
    <lodging_images>
      <lodging_image>
        <image_url>character(50)</image_url>
        <image_width>integer (pixels)</image_width>
        <image_height>integer (pixels)</image_height>
      </lodging_image>
    </lodging_images>
    <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>
    <lodging_rooms>
      <lodging_room>
        <room_id>integer </room_id>
        <room_units>
          <unit_id>character(50)</unit_id>
          <unit_name>character(50)</unit_name>
        </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_equipment>
          ...
        </room_equipment>
        <room_rates>
          <room_rate>
            <rate_id>integer</rate_id>
            <rate_persons>integer</rate_persons>            
            <rate_descriptions>
              <rate_description>
                <language>iso639-1</language>
                <text>character(50)</text>
              </rate_description>
            </rate_descriptions>
          </room_rate>
        </room_rates>
      </lodging_room>
    </lodging_rooms>
    <payments_schedule>
      <payment_schedule>
        <schedule>character(50)</schedule>
        <percentage>character(50)</percentage>
      </payment_schedule>
    </payments_schedule>
    <reviews>
      <review>
        <date>yyyy-MM-dd</date>
        <language>iso639-1</language>
        <name>character(50)</name>
        <rating>decimal</rating>
        <comment>character(1000)</comment>
      </review>
    </reviews>      
 </lodging>
</inventory_request_response>

Check-in and check-out schedule:

<lodging_checkin_schedule>
  <checkin>
    <from>integer</from>
    <to>integer</to>
    <price>integer</price>
  </checkin>
</lodging_checkin_schedule>    
<lodging_checkout_schedule>
  <checkout>
    <from>integer</from>
    <to>integer</to>
    <price>integer</price>
  </checkout>
</lodging_checkout_schedule>

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:

<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:

<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:

<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:

<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:

<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

  • No labels