Skip to content

Basic accommodation catalog

This method allows us to obtain the minimum and essential information about the different accommodations. It can be used, for example, to create an initial search page.

The result will be a list of the different available accommodations according to the search filters.

Access method

POST /Accommodation/BasicCatalog

Request structure

  • People: (list) Required. List of people included in the package. The order in which people are added to this list later determines the index to use in the Room property.

    • Person: (object) Required. Person information.

      • Type: (int) Required. Person type.

        Possible values
        • 0: Baby
        • 1: Child
        • 2: Adult
        • 3: Senior
        • 4: Generic
      • Age: (int) Optional. Person age. Required only if the person is a child or a baby (types 1 and 2).

  • AccommodationIds: (list) Optional. List that allows retrieving packages only from a specific set of accommodations.

    • (string): Optional. Accommodation identifier.
  • Destination: (object) Required. Geolocation used to search for accommodations. See SuggestedLocation.
    • Latitude: (decimal) Required. Geolocation latitude.
    • Longitude: (decimal) Required. Geolocation longitude.
  • CheckIn: (date) Required. Accommodation check-in date. ISO 8601 format (yyyy-MM-dd).
  • CheckOut: (date) Required. Accommodation check-out date. ISO 8601 format (yyyy-MM-dd).
  • RoomDistribution: (list) Required. List of rooms that will make up the package.

    • Room: (list) Required. Information about the people who make up this room.
      • (int): Required. Index corresponding to the position of the person in the People list.
  • Sort: (object) Optional. Result ordering.

    • Criteria: (int) Optional. Sort type.

      Possible values
      • 1: Cheapest first.
      • 2: Most expensive first.
      • 3: Closest first.
  • Paging: (object) Optional. Pagination information.

    • Number: (int) Optional. Requested page number.
    • Size: (int) Optional. Number of items per page.

Request examples

Example: 2 rooms: \"1 adult + 1 child\" and \"1 adult\"
{
    "People": [
        {
            "Type": 2
        },
        {
            "Type": 2
        },
        {
            "Type": 1,
            "Age": 5
        },
        {
            "Type": 2
        }
    ],
    "Destination": {           
        "Latitude": 42.3446912,
        "Longitude": 1.9566978000000
    },
    "CheckIn": "2023-01-25",
    "CheckOut": "2023-01-28",
    "RoomDistribution": [
        [
            0,
            1,
            2
        ],
        [
            3
        ]
    ],
    "Sort": {
        "Criteria": 1 
    },
    "Paging" : {
        "Number" : 1,
        "Size" : 10
    }
}
Example: 1 room: \"1 adult + 1 child\" in a 3* accommodation
{
    "People": [
        {
            "Type": 2
        },
        {
            "Type": 1,
            "Age": 5
        }
    ],
    "Destination": {           
        "Latitude": 42.3446912,
        "Longitude": 1.9566978000000
    },
    "CheckIn": "2023-01-25",
    "CheckOut": "2023-01-28",
    "RoomDistribution": [
        [
            0,
            1
        ]
    ]
    "Filter": {
        "AccommodationCategories": [
            3
        ]
    },
    "Sort": {
        "Criteria": 1 
    },
    "Paging" : {
        "Number" : 1,
        "Size" : 10
    }
}

Response structure

  • TotalPages: (int). Total number of pages.
  • Accommodations: (list). List of accommodations.
    • MainImageUrl: (string). Main accommodation image URL.
    • Name: (string). Accommodation name.
    • Description: (string). Accommodation description.
    • Address: (string). Accommodation address.
    • City: (string). City where the accommodation is located.
    • PostalCode: (string). Accommodation postal code.
    • Country: (string). Country where the accommodation is located.
    • Type: (string). Accommodation type.

      Possible values
      • 0: Unclassified
      • 1: Hotel
      • 2: Hostel
      • 3: Campsite
      • 4: Apartment
    • Category: (string). Accommodation category.

      Possible values
      • 0: Unknown.
      • 1: 1 Star.
      • 2: 2 Stars.
      • 3: 3 Stars.
      • 4: 4 Stars.
      • 5: 5 Stars.
  • AvailableFilters: (list). Provides information about the filters available according to the search criteria, for example to refine future searches using the Filter request parameter. In all cases, an array of objects is returned with Value (matching the values defined in Filter) and Count indicating how many matches exist for each filter. Information is returned for the following filters (see the Filter request parameter definition):

    • AccommodationBoards: (list)
    • AccommodationCategories: (list)
    • AccommodationCities: (list)
    • AccommodationRateClasses: (list)
    • AccommodationTypes: (list)
  • Success: (boolean). Value that indicates whether the call was processed correctly or not.

  • Errors: (list). Array of errors.
    • Error: (object).
      • ErrorMessage: (string). Error message explaining why the request was not successful. If it was correct, it will return null.
      • ErrorCode: (int). Code that identifies the error.
  • ErrorEntityBreakDown (list): list that contains objects with the name and ID in case of error.
    • Id (string): identifier
    • Name (string): related name of the identifier.

Response examples

Example
{
    "TotalPages": 1,
    "AvailableFilters": {
        "AccommodationBoards": [
            {
                "Value": 10,
                "Count": 19
            },
            {
                "Value": 20,
                "Count": 16
            },
            {
                "Value": 30,
                "Count": 12
            }
        ],
        "AccommodationCategories": [
            {
                "Value": 0,
                "Count": 1
            },
            {
                "Value": 1,
                "Count": 1
            },
            {
                "Value": 2,
                "Count": 4
            },
            {
                "Value": 3,
                "Count": 10
            },
            {
                "Value": 4,
                "Count": 8
            },
            {
                "Value": 5,
                "Count": 2
            }
        ],
        "AccommodationCities": [
            {
                "Value": "Andorra La Vella",
                "Count": 6
            },
            {
                "Value": "Camprodon",
                "Count": 1
            },
            {
                "Value": "Canillo",
                "Count": 3
            },
            {
                "Value": "Encamp",
                "Count": 2
            },
            {
                "Value": "Escaldes Engordany",
                "Count": 1
            },
            {
                "Value": "Escaldes Engordany - Andorra La Vella",
                "Count": 1
            },
            {
                "Value": "Font Romeu",
                "Count": 1
            },
            {
                "Value": "La Molina",
                "Count": 2
            },
            {
                "Value": "Les Angles",
                "Count": 1
            },
            {
                "Value": "Meritxell",
                "Count": 1
            },
            {
                "Value": "Mollo",
                "Count": 1
            },
            {
                "Value": "Pas De La Casa",
                "Count": 1
            },
            {
                "Value": "Ransol - Canillo",
                "Count": 1
            },
            {
                "Value": "Ribes De Freser",
                "Count": 1
            },
            {
                "Value": "Soldeu",
                "Count": 3
            }
        ],
        "AccommodationRateClasses": [
            {
                "Value": 1,
                "Count": 7
            },
            {
                "Value": 2,
                "Count": 25
            }
        ],
        "AccommodationTypes": [
            {
                "Value": 0,
                "Count": 1
            },
            {
                "Value": 1,
                "Count": 18
            },
            {
                "Value": 2,
                "Count": 1
            },
            {
                "Value": 4,
                "Count": 6
            }
        ]
    },
    "Accommodations": [
        {
            "Distance": 26601.1617431278,
            "Price": 82.18,
            "MainImageUrl": "https://some.url.com/giata/29/291641/291641a_hb_a_004.jpg",
            "Id": "291641/weqn6yqht5bfw",
            "Name": "Chalets de l'Isard - Vacanceole",
            "Description": "Esta sencilla residencia se encuentra en Les Angles. Ubicada a 300 metros del centro del pueblo, la propiedad brinda un fácil acceso a todo lo que este destino tiene para ofrecer. El establecimiento está a 10 metros de las pistas. El alojamiento se encuentra a 13. 0 km de las principales conexiones con el transporte público. Chalets de l'Isard - Vacanceole tiene un total de 81 dormitorios disponibles para sus huéspedes. Asimismo, el alojamiento cuenta con Wi-Fi gratuito. Chalets de l'Isard - Vacanceole no ofrece servicio de recepción 24 horas. Desafortunadamente, no hay habitaciones en las que las personas que se hospeden en este alojamiento puedan pedir una cuna para los más pequeños. Las zonas comunes de la propiedad están adaptadas a personas con discapacidad. El establecimiento también dispone de una habitación accesible. Este establecimiento es ecológicamente sostenible. Los huéspedes de este establecimiento podrán aprovechar sus múltiples servicios de salud y bienestar. La residencia puede cobrar el importe de algunos de estos servicios. ",
            "Address": "Route du Pla del Mir",
            "City": "Les Angles",
            "PostalCode": "66210",
            "Country": "France",
            "Type": 0,
            "Category": 0            
        },
        {
            "Distance": 19014.6253644023,
            "Price": 99.24,
            "MainImageUrl": "https://some.url.com/giata/14/145242/145242a_hb_a_002.jpg",
            "Id": "145242/weqn6yqht5bfw",
            "Name": "The Catalogne",
            "Description": "Este maravilloso hotel está convenientemente ubicado en el corazón de Font Romeu, a sólo 200 metros del a telecabina de esquí y de un campo de golf. Entre otros servicios, el establecimiento ofrece alquiler de material de esquí y venta de forfaits en el hotel. Hay acceso a Internet disponible en todo el edificio y los huéspedes que lleguen en coche podrán dejar su vehículo en el aparcamiento del hotel. Este establecimiento consta de un total de 42 apartamentos, todos ellos con vistas espléndidas a la cordillera de los Pirineos. Los huéspedes seguramente disfrutarán de pasar el rato en la acogedora sala de estar con TV, o de relajarse con un buen libro o un refresco en la zona de estar y comedor.",
            "Address": "Avenue D'Espagne, 9 BP49",
            "City": "Font Romeu",
            "PostalCode": "66120",
            "Country": "France",
            "Type": 4,
            "Category": 1            
        }
    ],
    "Success": true
}