OpenTravel Alliance · Example Payload

Opentravel 2018A Hospitality Facility Facilityqueryretrievehospitalityavailability

TravelUnited StatesStandardsAviationHospitalityHotelsCar RentalRailCruiseDistributionGDSBookingChannelXMLJSON Schema

Opentravel 2018A Hospitality Facility Facilityqueryretrievehospitalityavailability is an example object payload from OpenTravel Alliance, with 1 top-level field. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

FacilityQueryRetrieveHospitalityAvailability

Example Payload

Raw ↑
{
  "FacilityQueryRetrieveHospitalityAvailability" : {
    "BasePayload" : {
      "@type" : "BasePayload",
      "PayloadStdAttributes" : {
        "value" : null,
        "echoToken" : "Example String Value",
        "timeStamp" : "2011-01-24T09:45:00-06:00",
        "target" : "Test",
        "targetName" : "Example String Value",
        "version" : 12,
        "transactionIdentifier" : "Example String Value",
        "sequenceNmbr" : "Example String Value",
        "transactionStatusCode" : "Start",
        "correlationID" : "Example String Value",
        "primaryLangID" : "en",
        "altLangID" : "es",
        "retransmissionIndicatorInd" : true
      },
      "POS" : {
        "@type" : "POS",
        "Source" : [ {
          "@type" : "Source",
          "agentSine" : "Example String Value",
          "pseudoCityCode" : "Example String Value",
          "iSOCountry" : "IR",
          "iSOCurrency" : "USD",
          "agentDutyCode" : "Example String Value",
          "airlineVendorID" : "B6",
          "airportCode" : "IAD",
          "firstDepartPoint" : "Example String Value",
          "eRSP_UserID" : "Example String Value",
          "terminalID" : "Example String Value",
          "RequestorID" : {
            "@type" : "RequestorIDDetail",
            "messagePassword" : "Example String Value",
            "personName" : "Example String Value",
            "Identifier" : {
              "value" : "guid12345",
              "url" : "http://www.w3.org/2001/XMLSchema",
              "system" : "sysABC3344",
              "organization" : "Acme"
            }
          },
          "Position" : {
            "value" : null,
            "latitude" : "Example String Value",
            "longitude" : "Example String Value",
            "altitude" : "Example String Value",
            "altitudeUnitOfMeasure_Enum" : "Miles",
            "mapURL" : "http://www.OpenTravel.org/ns/OTA2/Common_v01_00",
            "formatURL" : "http://www.w3.org/2001/XMLSchema"
          },
          "BookingChannel" : {
            "@type" : "BookingChannel",
            "primaryInd" : true,
            "CompanyName" : {
              "value" : "Travel Adventure Partners Incorporated",
              "division" : "Travel Division",
              "department" : "Adventure department",
              "shortName" : "Adventure Inc",
              "code" : "AI",
              "codeContext" : "Example String Value",
              "description" : "Example String Value"
            },
            "Type" : {
              "value" : "Agent"
            }
          }
        } ]
      },
      "ProcessingInfo" : {
        "value" : null,
        "displayCurrency" : "USD",
        "positiveInteger" : 1234,
        "summaryResultsInd" : true
      }
    },
    "FacilityQueryHotelAvailRetrieve" : {
      "FacilityIdentifier" : [ {
        "objID" : "facility_1",
        "FacilityRef" : "facility_1",
        "FacilityKey" : {
          "@type" : "FacilityKeyIdentifier",
          "Identifier" : {
            "value" : "guid12345",
            "url" : "http://www.OpenTravel.org/ns/OTA2/Common_v01_00",
            "system" : "sysABC3344",
            "organization" : "Acme"
          }
        }
      } ],
      "BaseHospitalityFacilityQuery" : {
        "@type" : "BaseHospitalityFacilityQuery",
        "numberOfRooms" : 1,
        "DateTimeSpan" : {
          "value" : null,
          "start" : "2016-08-22T19:32:52Z",
          "end" : "2016-08-28T04:32:52Z"
        },
        "GuestCount" : [ {
          "value" : 2345,
          "ageQualifyingCode" : "Example String Value",
          "age" : 3456
        } ],
        "RateRange" : {
          "value" : null,
          "minRate" : 100.0000,
          "maxRate" : 100.0000,
          "fixedRate" : 100.0000,
          "rateTimeUnit" : "Day",
          "currencyCode" : "USD"
        },
        "DetailedHotelSearchCriteria" : {
          "@type" : "DetailedHotelSearchCriteria",
          "hotelCodeContext" : "Sabre",
          "tTIcode" : 4567,
          "petsAllowedInd" : true,
          "smokingRoomsInd" : true,
          "aDACompliantInd" : true,
          "exactMatchInd" : true,
          "Features" : {
            "@type" : "FeaturesAccessibility",
            "quantity" : 1234,
            "Description" : {
              "@type" : "Description",
              "name" : "paragraph name",
              "number" : 1234,
              "Description" : [ {
                "value" : "Formatted text example.",
                "language" : "en",
                "textFormat" : "PlainText"
              }, "http://www.w3.org/2001/XMLSchema", {
                "value" : null,
                "listItem" : 2345,
                "text2" : "Formatted text example.",
                "language" : "en",
                "textFormat" : "HTML"
              } ],
              "Image" : [ {
                "@type" : "Image",
                "objID" : "image_1",
                "version" : "Example String Value",
                "format" : "2",
                "dimensionCategory" : "Example String Value",
                "sort" : 2345,
                "resolution" : 3456,
                "colorSpace" : "Example String Value",
                "originalIndicatorInd" : true,
                "Identifier" : {
                  "value" : "guid12345",
                  "url" : "http://www.w3.org/2001/XMLSchema",
                  "system" : "sysABC3344",
                  "organization" : "Acme"
                },
                "ImageRef" : "image_1",
                "URL" : "http://www.OpenTravel.org/ns/OTA2/Common_v01_00",
                "Details" : {
                  "value" : "Example String Value",
                  "author" : "Example String Value",
                  "copyrightNotice" : "Example String Value",
                  "copyrightOwner" : "Example String Value",
                  "copyrightStart" : "2011-07-04T14:15:00+06:00",
                  "copyrightEnd" : "2011-12-05T06:00:00Z",
                  "effectiveStart" : "2011-01-24T09:45:00-06:00",
                  "effectiveEnd" : "2011-07-04T14:15:00+06:00",
                  "applicableStart" : "2011-01-24",
                  "applicableEnd" : "2011-07-04"
                },
                "MultimediaDescription" : [ {
                  "@type" : "MultimediaDescription",
                  "title" : "Example String Value",
                  "language" : "en",
                  "caption" : "The Empire State Building at sunset.",
                  "FormattedTextSubSection" : [ {
                    "@type" : "FormattedTextSubSection",
                    "subTitle" : "Example String Value",
                    "subCode" : "Example String Value",
                    "subSectionNumber" : 4567,
                    "TextParagraph" : [ ]
                  } ]
                } ],
                "DateTimeStamp" : {
                  "value" : "2011-12-05T06:00:00Z",
                  "create" : "2011-01-24T09:45:00-06:00",
                  "creatorID" : "c123456789",
                  "lastModify" : "2011-07-04T14:15:00+06:00",
                  "lastModifierID" : "m987654321",
                  "purge" : "2011-12-05"
                },
                "Email" : {
                  "@type" : "Email",
                  "remark" : "Example String Value",
                  "textFormat" : "Example String Value",
                  "validInd" : true,
                  "defaultInd" : true,
                  "Address" : "Example String Value",
                  "Type" : {
                    "value" : "Business"
                  },
                  "Privacy" : {
                    "value" : null,
                    "shareMarketInd" : "Yes",
                    "shareSyncInd" : "No",
                    "optInStatus" : "OptedIn",
                    "optInDate" : "2011-12-05T06:00:00Z",
                    "optOutDate" : "2011-01-24T09:45:00-06:00"
                  }
                },
                "Dimensions" : {
                  "value" : null,
                  "unitOfMeasureCode" : "2",
                  "width" : 1234,
                  "height" : 2345
                },
                "File" : {
                  "value" : null,
                  "name" : "Example String Value",
                  "size" : 3456,
                  "originalName" : "Example String Value"
                },
                "Geolocation" : {
                  "value" : null,
                  "latitude" : "Example String Value",
                  "longitude" : "Example String Value",
                  "altitude" : "Example String Value",
                  "altitudeUnitOfMeasure_Enum" : "Kilometers",
                  "mapURL" : "http://www.w3.org/2001/XMLSchema",
                  "formatURL" : "http://www.OpenTravel.org/ns/OTA2/Common_v01_00"
                }
              } ],
              "DateTimeStamp" : {
                "value" : "2011-07-04T14:15:00+06:00",
                "create" : "2011-12-05T06:00:00Z",
                "creatorID" : "c123456789",
                "lastModify" : "2011-01-24T09:45:00-06:00",
                "lastModifierID" : "m987654321",
                "purge" : "2011-01-24"
              }
            },
            "AccessibilityFeatures" : {
              "@type" : "AccessibilityFeaturesDetail",
              "AccessibilityFeatures" : {
                "value" : "Accessibility to goods and services"
              },
              "Description" : {
                "value" : "Formatted text example.",
                "language" : "en",
                "textFormat" : "PlainText"
              }
            }
          },
          "BedType" : {
            "value" : "Dorm bed"
          },
          "HotelAmenity" : [ {
            "value" : "Example String Value",
            "codeContext" : "Example String Value",
            "description" : "Example String Value"
          } ],
          "RoomAmenities" : [ {
            "value" : "Example String Value",
            "codeContext" : "Example String Value",
            "description" : "Example String Value"
          } ],
          "Rating" : 3.5
        },
        "RoomTypeCode" : [ {
          "value" : "Example String Value",
          "codeContext" : "Example String Value",
          "description" : "Example String Value"
        } ],
        "RatePlanCode" : [ {
          "value" : "AAAB",
          "ratePlanType" : "Other_",
          "ratePlanTypeExtension" : "ratePlanType_Other_Value",
          "ratePlanID" : "12345678",
          "ratePlanCategory" : "POD",
          "promotionCode" : "L9Z",
          "promotionVendorCode" : [ "WT1" ],
          "ratePlanQualifierInd" : true
        } ]
      }
    }
  }
}