<commit_before>---
title: Availability 
layout: reference
---

# Availablity

Message to retrived the availability of hotels

|  SOAPAction |	OTA name | Message structure | 
|----------|-----------|---------------------|
| availability | HotelAvail | OTA_HotelAvailRQ |

---

## Request

**OTA_HotelAvailRQ**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| AvailRequestSegments | Y | ComplexType	| A collection of AvailRequestSegment. Each segment includes a collection of criteria that requests a bookable entity, which may include designated rate plans, room types, amenities or services, and the request can be used for guest rooms or other inventory items for which availability is sought. Each segment would be presumed to have a unique date range for each request. |


**AvailRequestSegments**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| AvailRequestSegment | Y | ComplexType | To accommodate the ability to perform multiple requests within one message, the availability request contains the repeating element, AvailRequestSegment. Each segment includes a collection of criteria that requests a bookable entity, which may include designated rate plans, room types, amenities or services, and the request can be used for guest rooms or other inventory items for which availability is sought. Each segment would be presumed to have a unique date range for each request.  **do we support only one?** |


**AvailRequestSegment**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| HotelSearchCriteria | Y | ComplexType | Specified hotel search criteria. **How many HotelSerachCriteria do we have per AvailRequestSegment??**|
| StayDateRange | N | ComplexType | Reer to StayDateRange in Search |
| RoomStayCandidates | N | ComplexType | List of available room products. |


**HotelSearchCriteria**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| Criterion | Y | ComplexType	| Refer to Criterion in Search.  Note that for Availability the Criterion will only have the HotelRef element. Other elements will not be sent. HotelSearchCriteria can contain multiple Criterion elements.  Each will have a unique HotelCode per Availability request. **Not current - we need to decide how to handle this because the spec says the position field is requiered here** |


**RoomStayCandidates**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| RoomStayCandidate | Y | ComplexType	| Element used to identify available room products. |


**RoomStayCandidate**
<commit_msg>Adding comments for AvailRequestSegments<commit_after>---
title: Availability 
layout: reference
---

# Availablity

Message to retrived the availability of hotels

|  SOAPAction |	OTA name | Message structure | 
|----------|-----------|---------------------|
| availability | HotelAvail | OTA_HotelAvailRQ |

---

## Request

**OTA_HotelAvailRQ**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| AvailRequestSegments | Y | ComplexType	| A collection of AvailRequestSegment. Each segment includes a collection of criteria that requests a bookable entity, which may include designated rate plans, room types, amenities or services, and the request can be used for guest rooms or other inventory items for which availability is sought. Each segment would be presumed to have a unique date range for each request. Concur will ever only ever send one AvailRequestSegments |


**AvailRequestSegments**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| AvailRequestSegment | Y | ComplexType | To accommodate the ability to perform multiple requests within one message, the availability request contains the repeating element, AvailRequestSegment. Each segment includes a collection of criteria that requests a bookable entity, which may include designated rate plans, room types, amenities or services, and the request can be used for guest rooms or other inventory items for which availability is sought. Each segment would be presumed to have a unique date range for each request. Concur will only ever send one AvailRequestSegment |


**AvailRequestSegment**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| HotelSearchCriteria | Y | ComplexType | Specified hotel search criteria. Concur will ever only ever send one HotelSearchCriteria. |
| StayDateRange | N | ComplexType | Reer to StayDateRange in Search |
| RoomStayCandidates | N | ComplexType | List of available room products. |


**HotelSearchCriteria**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| Criterion | Y | ComplexType	| Refer to Criterion in Search.  Note that for Availability the Criterion will only have the HotelRef element. Other elements will not be sent. HotelSearchCriteria can contain multiple Criterion elements.  Each will have a unique HotelCode per Availability request. **Not current - we need to decide how to handle this because the spec says the position field is requiered here** |


**RoomStayCandidates**

|  Element |	Required | Data Type 	|  Description |
|----------|-----------|---------------------------|-|
| RoomStayCandidate | Y | ComplexType	| Element used to identify available room products. |


**RoomStayCandidate**

{'fraction_non_alphanumeric': 0.16352648418059013, 'fraction_numerical': 0.0, 'mean_word_length': 2.814915254237288, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1116062', 'n_tokens_mistral': 1369, 'n_tokens_neox': 1282, 'n_words': 611}