リクエスト
構文
OTA_HotelAvailNotifRQ
メッセージでは、次の構文を使用します。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="message_ID" TimeStamp="timestamp" Version="3.0"> <POS> <Source> <RequestorID ID="partner_account_name"/> </Source> </POS> <AvailStatusMessages HotelCode="HotelID"> <AvailStatusMessage BookingLimit="integer"> <StatusApplicationControl Start="YYYY-MM-DD" End="YYYY-MM-DD" Mon="boolean_value" Tue="boolean_value" Weds="boolean_value" Thur="boolean_value" Fri="boolean_value" Sat="boolean_value" Sun="boolean_value" InvTypeCode="RoomID"/> </AvailStatusMessage> <AvailStatusMessage> <StatusApplicationControl Start="YYYY-MM-DD" End="YYYY-MM-DD" Mon="boolean_value" Tue="boolean_value" Weds="boolean_value" Thur="boolean_value" Fri="boolean_value" Sat="boolean_value" Sun="boolean_value" InvTypeCode="RoomID" RatePlanCode="PackageID"/> <LengthsOfStay> <LengthOfStay Time="integer" TimeUnit="[Day]" MinMaxMessageType="[SetMaxLOS|SetMinLOS|SetForwardMaxStay| SetForwardMinStay]"/> </LengthsOfStay> <RestrictionStatus Status="[Close|Open]" Restriction="[Arrival|Departure|Master]" MaxAdvancedBookingOffset="integer_or_duration" MinAdvancedBookingOffset="integer_or_duration"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
要素と属性
OTA_HotelAvailNotifRQ メッセージには、次の要素と属性があります。要素 / @属性 | 発生数 | 型 | 説明 |
---|---|---|---|
OTA_HotelAvailNotifRQ | 1 | 複合要素 | 客室料金の可用性(客室料金を取得できるかどうか)を定義するメッセージのルート要素。 |
OTA_HotelAvailNotifRQ / @xmlns | 0~1 | String(URI) | XML 名前空間。 |
OTA_HotelAvailNotifRQ / @EchoToken | 1 | String | この要求メッセージの一意の識別子。この値は応答メッセージ内で返されます。使用できる文字は、a~z、A~Z、0~9、_(アンダースコア)、-(ダッシュ)です。 |
OTA_HotelAvailNotifRQ / @TimeStamp | 1 | DateTime | このメッセージの作成日時。 |
OTA_HotelAvailNotifRQ / @Version | 1 | Decimal | OpenTravel メッセージのバージョン。 |
OTA_HotelAvailNotifRQ / POS | 0~1 | POS | このメッセージのパートナー アカウントを指定するコンテナ(通常、バックエンドが複数のパートナー アカウントの料金フィードを提供している場合に使用されます)。 |
OTA_HotelAvailNotifRQ / POS/ Source | 1 | Source | <POS> が存在する場合は必須で、<RequestorID> のコンテナです。 |
OTA_HotelAvailNotifRQ / POS / RequestorID | 1 | RequestorID | <POS> が存在する場合は必須で、パートナー アカウントを定義します。 |
OTA_HotelAvailNotifRQ / POS / RequestorID / @ID | 1 | String | このメッセージのパートナー アカウント。この文字列の値は、Hotel Center の [アカウント設定] ページに表示されている [パートナーキー] の値です。
注: 複数のアカウントのフィードを提供するバックエンドを使用している場合、この値は、Transaction(宿泊施設データ)メッセージの |
OTA_HotelAvailNotifRQ / AvailStatusMessages | 1 | AvailStatusMessages | 1 つ以上の <AvailStatusMessage> 要素のコンテナ。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / @HotelCode | 1 | String | 宿泊施設の一意の識別子。この値は、ホテルリスト フィードの <listing> 要素の <id> を使用して指定した HotelID と一致する必要があります。HotelID は Hotel Center にも表示されます。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage | 1~n | AvailStatusMessage | 1 つの宿泊施設に関する、異なる期間での客室料金の可用性と制限を定義します。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / @BookingLimit | 1 | Int |
注: この属性の設定よりも、OTA_HotelInvCountNotifRQ メッセージが優先されます。 <StatusApplicationControl> の期間で予約可能な残り客室数。BooklingLimit が指定されている場合、<StatusApplicationControl> では InvTypeCode を指定する必要があり、<AvailStatusMessage> には <LengthOfStay> または <RestrictionStatus> を含めることはできません。0 以上である必要があります。負の値が指定されているか、指定されていない場合のデフォルトは 0 です。
注: 特定の |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl | 1 | StatusApplicationControl | 期間のほか、客室タイプ(InvTypeCode )と料金プラン(RatePlanCode )の識別子を定義します。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @Start | 1 | Date | 期間の開始日。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @End | 1 | Date | 期間の終了日。start の値以上にする必要があります。start と end が等しい場合は、その日付に更新が適用されます。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @Mon | 0~1 | Boolean | 月曜日を明示的に含めるには、true または 1 に設定します。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @Tue | 0~1 | Boolean | 火曜日を明示的に含めるには、true または 1 に設定します。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @Weds | 0~1 | Boolean | 水曜日を明示的に含めるには、true または 1 に設定します。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @Thur | 0~1 | Boolean | 木曜日を明示的に含めるには、true または 1 に設定します。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @Fri | 0~1 | Boolean | 金曜日を明示的に含めるには、true または 1 に設定します。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @Sat | 0~1 | Boolean | 土曜日を明示的に含めるには、true または 1 に設定します。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @Sun | 0~1 | Boolean | 日曜日を明示的に含めるには、true または 1 に設定します。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @InvTypeCode | 1 | String | 在庫の一意の識別子(客室タイプ)。この値は、Transaction(宿泊施設データ)メッセージの <RoomID> に対応します。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / StatusApplicationControl / @RatePlanCode | 0~1 | String | 料金プランの一意の識別子。この ID は、Transaction(宿泊施設データ)メッセージの <PackageID> の値に対応します。料金プランの詳細を定義し、料金プランが参照される場所は、<OTA_HotelRateAmountNotifRQ> メッセージと <OTA_HotelAvailNotifRQ> メッセージ両方の <StatusApplicationControl> 内です。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / LengthsOfStay | 0~1 | LengthsOfStay | LOS 制限を定義するためのコンテナ。<AvailStatusMessage> に BookingLimit 属性が含まれている場合は、指定できません。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / LengthsOfStay / LengthOfStay | 1~n | LengthOfStay | 滞在日数に関する制限を定義します。複数の <LengthOfStay> 要素を使用する場合は、それぞれの要素で異なる MinMaxMessageType 値を指定する必要があります。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / LengthsOfStay / LengthOfStay / @Time | 1 | Int | 滞在日数の測定の単位値。値 0 は、制限なしとして扱われます。たとえば、<LengthOfStay
Time="0" MinMaxMessageType="SetMaxLOS"/> は最大滞在日数がないことを意味します。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / LengthsOfStay / LengthOfStay / @TimeUnit | 0~1 | Enum | 時間の単位。指定しない場合のデフォルトは「Day」です。有効な値は次のとおりです。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / LengthsOfStay / LengthOfStay / @MinMaxMessageType | 1 | Enum | 各種の滞在日数の制限。SetMaxLOS と SetMinLOS は到着ベースで、到着日の時点で 1 日目になります。
SetForwardMinStay と SetForwardMaxStay は滞在期間ベースで、実際の滞在期間で計測します。最大値は最小値以上にする必要があります。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / RestrictionStatus | 0~1 | RestrictionStatus | 宿泊プランの制限を定義します。<AvailStatusMessage> に BookingLimit 属性が含まれている場合は、指定できません。 |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / RestrictionStatus / @Status | 0~1 | Enum |
注: 特定の |
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / RestrictionStatus / @Restriction | 0~1 | Enum |
有効な値は次のとおりです。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / RestrictionStatus / @MinAdvancedBookingOffset | 0~1 | Int または期間 | 到着日から遡って、この客室料金で予約可能な最小期間。
有効な値の型は次のとおりです。
|
OTA_HotelAvailNotifRQ / AvailStatusMessages / AvailStatusMessage / RestrictionStatus / @MaxAdvancedBookingOffset | 0~1 | Int または期間 | 到着日から遡って、この客室料金で予約可能な最大期間。
有効な値の型は次のとおりです。
|
例
例 1
最小と最大の滞在日数(到着日ベース)を設定します。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <LengthsOfStay> <LengthOfStay Time="5" MinMaxMessageType="SetMaxLOS"/> <LengthOfStay Time="2" MinMaxMessageType="SetMinLOS"/> </LengthsOfStay> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
例 2
最小と最大の滞在日数(滞在期間ベース)を設定します。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <LengthsOfStay> <LengthOfStay Time="5" MinMaxMessageType="SetForwardMaxStay"/> <LengthOfStay Time="2" MinMaxMessageType="SetForwardMinStay"/> </LengthsOfStay> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
例 3
Closed-to-Departure の制限を設定します(この場合、指定の日にチェックアウトする宿泊プランが許可されません)。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <RestrictionStatus Status="Close" Restriction="Departure"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
例 4
Closed-to-Arrival の制限を設定します(この場合、指定の日にチェックインする宿泊プランが許可されません)。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <RestrictionStatus Status="Close" Restriction="Arrival"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
例 5
指定した日付の客室タイプと料金プランに関する「Open」の空室状況。
注: 料金を完全に利用可能にする前に、1 泊あたりの客室料金が必要です。また、その客室タイプの在庫数は 0 より大きい値であることが必要です。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <RestrictionStatus Status="Open" Restriction="Master"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
例 6
指定した日付の客室タイプと料金プランに関する「Close」の空室状況(「販売停止」とも呼ばれます)。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <RestrictionStatus Status="Close" Restriction="Master"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
例 7
週末のみに適用される、最小と最大の予約可能期間の制限を設定します。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage> <StatusApplicationControl Start="2020-01-01" End="2020-06-30" Mon=”false” Tue=”false” Weds=”false” Thur=”false” Fri=”false” Sat=”true” Sun=”true” InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <RestrictionStatus MaxAdvancedBookingOffset="30" MinAdvancedBookingOffset="2"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
例 8
客室タイプと料金プランに関して、同じ日付に複数の制限を設定します。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <RestrictionStatus Status="Open" Restriction="Master"/> </AvailStatusMessage> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <RestrictionStatus Status="Close" Restriction="Arrival"/> </AvailStatusMessage> <AvailStatusMessage> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1" RatePlanCode="PackageID_1"/> <RestrictionStatus Status="Close" Restriction="Departure"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
例 9
指定した日付での客室タイプの在庫数を設定します。
注: この属性の設定よりも、OTA_HotelInvCountNotifRQ メッセージが優先されます。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="12345678" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <AvailStatusMessages HotelCode="Property_1"> <AvailStatusMessage BookingLimit="5"> <!-- Note: RatePlanCode must not be specified here when setting inventory counts. --> <StatusApplicationControl Start="2020-05-18" End="2020-05-23" InvTypeCode="RoomID_1"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ>
応答
構文
OTA_HotelAvailNotifRS
メッセージでは、次の構文を使用します。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="timestamp" EchoToken="echo_token" Version="3.0"> <!-- Either Success or Errors will be populated. --> <Success/> <Errors> <Error Type="12" Status="NotProcessed" ShortText="issue_code">issue_description</Error> </Errors> </OTA_HotelAvailNotifRS>
要素と属性
OTA_HotelAvailNotifRS
メッセージには、次の要素と属性があります。
要素 / @属性 | 発生数 | 型 | 説明 |
---|---|---|---|
OTA_HotelAvailNotifRS | 1 | 複合要素 | 空室状況メッセージへのレスポンスのルート要素。 |
OTA_HotelAvailNotifRS / @TimeStamp | 1 | DateTime | このメッセージの作成日時。 |
OTA_HotelAvailNotifRS / @EchoToken | 1 | String | 関連する OTA_HotelAvailNotifRQ メッセージから得られる一意の識別子。 |
OTA_HotelAvailNotifRS / Success | 0~1 | Success | OTA_HotelAvailNotifRQ メッセージが正常に処理されたことを示します。
各メッセージには、 |
OTA_HotelAvailNotifRS / Errors | 0~1 | Errors | OTA_HotelAvailNotifRQ メッセージの処理中に発生した 1 つ以上の問題のコンテナ。
各メッセージには、 |
OTA_HotelAvailNotifRS / Errors / Error | 1~n | Error | OTA_HotelAvailNotifRQ メッセージの処理中に発生したエラーの説明。これらのエラーの詳細については、フィード ステータスのエラー メッセージをご覧ください。 |
OTA_HotelAvailNotifRS / Errors / Error / @Type | 1 | Integer | エラーに関連付けられている OpenTravel Alliance EWT(エラー警告タイプ)。値 12 (Processing exception) のみが使用されます。 |
OTA_HotelAvailNotifRS / Errors / Error / @Code | 1 | Integer | エラーに関連付けられている OpenTravel Alliance ERR(エラーコード)。
値 450 (Unable to process) のみが使用されます。 |
OTA_HotelAvailNotifRS / Errors / Error / @Code | 1 | Enum | 元のリクエストのステータス。値 NotProcessed のみが使用されます。 |
OTA_HotelAvailNotifRS / Errors / Error / @ShortText | 1 | String | 問題に関する Google 識別子。これらのエラーの詳細については、フィード ステータスのエラー メッセージをご覧ください。 |
例
Success
以下は、適切に処理された OTA_HotelAvailNotifRQ メッセージに対するレスポンスです。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <Success/> </OTA_HotelAvailNotifRS>
Errors
以下は、エラーのため処理されなかった OTA_HotelAvailNotifRQ メッセージに対するレスポンスです。
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelAvailNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2020-05-13T20:50:37-05:00" Version="3.0"> <Errors> <Error Type="12" Code="450" Status="NotProcessed" ShortText="8001">Example</Error> </Errors> </OTA_HotelAvailNotifRS>