Contact information
Request
XSD File : OTA_HotelDescriptiveInfoRQ.xsd
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelDescriptiveInfoRQ xmlns="http://www.opentravel.org/OTA/2003/05" PrimaryLangID="fr" AltLangID="de" RetransmissionIndicator="0" TimeStamp="2014-12-15T14:30:00+01:00" Target="Test" Version="1.000"> <POS> <Source> <RequestorID ID="YOURUSERNAME" MessagePassword="YOURPASSWORD" Type="13"/> </Source> </POS> <HotelDescriptiveInfos> <HotelDescriptiveInfo HotelCode="YOUTHOTELCODE"> <ContactInfo SendData="true" /> </HotelDescriptiveInfo> </HotelDescriptiveInfos> </OTA_HotelDescriptiveInfoRQ>
Response
XSD File : OTA_HotelDescriptiveInfoRS.xsd
<?xml version="1.0" encoding="UTF-8"?> <OTA_HotelDescriptiveInfoRS xmlns="http://www.opentravel.org/OTA/2003/05" PrimaryLangID="fr" AltLangID="de" RetransmissionIndicator="0" TimeStamp="2015-09-09T10:09:21+02:00" Target="Test" Version="1.0" CorrelationID="1"> <Success></Success> <HotelDescriptiveContents> <HotelDescriptiveContent HotelName="YOURHOTELNAME"> <ContactInfos> <ContactInfo ContactProfileID="" ContactProfileType="" Location="" Removal=""> <Names> <Name Language="" ShareMarketInd="" ShareSynchInd=""> <NamePrefix>CONTACTNAMEPREFIX</NamePrefix> <GivenName>CONTACTGIVENNAME</GivenName> <Surname>CONTACTSURNAME</Surname> <JobTitle>CONTACTJOBTITLE</JobTitle> </Name> </Names> <Addresses> <Address FormattedInd="" ValidInd="" UseType=""> <StreetNmbr>NUM</StreetNmbr> <AddressLine>STREET</AddressLine> <CityName>CITY</CityName> <County>COUNTY</County> <PostalCode>POSTALCODE</PostalCode> <StateProv>STATE</StateProv> <CountryName Code="COUNTRYCODE">COUNTRYNAME</CountryName> </Address> </Addresses> <Phones> <Phone CountryAccessCode="" PhoneNumber="" PhoneTechType="" PhoneUseType="" ShareMarketInd="" ShareSynchInd="" ID=""/> <Phone CountryAccessCode="" PhoneNumber="" PhoneTechType="" PhoneUseType="" ShareMarketInd="" ShareSynchInd="" ID=""/> <Phone CountryAccessCode="" PhoneNumber="" PhoneTechType="" PhoneUseType="" ShareMarketInd="" ShareSynchInd="" ID=""/> </Phones> <Emails> <Email EmailType="" TextFormat="" ShareMarketInd="" ShareSynchInd="">CONTACTEMAIL</Email> </Emails> <CompanyName>CONTACTCOMPANYNAME</CompanyName> </ContactInfo> </ContactInfos> </HotelDescriptiveContent> </HotelDescriptiveContents> </OTA_HotelDescriptiveInfoRS>
Details:
Element | Attribute | Description | Value type | Always present | Repetitive |
---|---|---|---|---|---|
ContactInfos | A collection of ContactInfo elements that provides detailed contact information. | no | no | ||
ContactInfo | The ContactInfo class is used to define the contacts for consumers and technical people at the hotel facility, including various telephone numbers and e-mail addresses, or any respective attribute or affiliation for the hotel. | yes | yes | ||
ContactProfileID | This is a profile identifier for the contact, the type may be defined by the ContactProfileType. | String | |||
ContactProfileType | This defines what type of ContactProfileID is being provided (e.g. IATA, chain specific, etc.) | String | |||
Location | The location of the contact (e.g., at a hotel property, at a central office). Refer to OpenTravel Code List Contact Location (CON). | OTA_CodeType | |||
Removal | If true, this item is obsolete and should be removed from the receiving system. | Boolean | |||
Names | A collection of Name elements. | yes | no | ||
Name | Used to pass detailed name information regarding a contact. | yes | no | ||
CorporatePosition | The corporate position of the contact. | String | |||
Language | Name representation language. | Language | |||
Location | The location of the hotel contact. e.g.: at the hotel property, at a central office, etc. Refer to OpenTravel Code List Contact Location (CON). | OTA_CodeType | |||
NameOrdered | The proper name in the usual order (e.g. used for correspondance Mr. James Smith). | String | |||
NameType | Defines the type of the job title (e.g. regional office postion, corporate, executive). | StringLength1to64 | |||
OKToPublish | Indicates whether the contact information can be published externally (on a web site for the general public) or whether this is strictly a contact to be used in conjunction with the data feed (limited use). | Boolean | |||
SrvcCode | The information describing the contact service code for a hotel facility. (e.g., who to contact about golf tours). Refer to OpenTravel Code List Contact Srvc Code (CSC). | OTA_CodeType | |||
CodeDetail | May be used to give further detail on the code. | StringLength1to128 | |||
Removal | If true, this item is obsolete and should be removed from the receiving system. | Boolean | |||
Gender | Used to provide gender information. | Gender_Type | |||
ID | The ID attribute in this group is a unique identifying value assigned by the creating system and may be used to reference a primary-key value within a database or in a particular implementation. | StringLength1to32 | |||
ShareMarketInd | Permission for sharing data for marketing purposes. | Sharing_Type | |||
ShareSynchInd | Permission for sharing data for synchronization of information held by other travel service providers. | Sharing_Type | |||
GivenName | Given name, first name or names. | StringLength1to64 | no | no | |
MiddleName | The middle name of the person name. | StringLength1to64 | no | no | |
JobTitle | Defines the type of the job title (e.g. regional office postion, corporate, executive). | StringLength1to64 | no | no | |
NamePrefix | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) | StringLength1to16 | no | no | |
Surname | Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name. | StringLength1to64 | no | no | |
Addresses | A collection of Address elements. | no | no | ||
Address | A physical address or location type and name | no | yes | ||
FormattedInd | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | Boolean | |||
ValidInd | Valid email address indicator | Boolean | |||
UseType | Describes the use of the address (e.g. mailing, delivery, billing, etc.). Refer to OpenTravel Code List Address Use Type (AUT). | OTA_CodeType | |||
StreetNmbr | May contain the street number and optionally the street name. | String | no | no | |
AddressLine | When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. | String | no | yes | |
CityName | City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). | String | no | no | |
County | County or Region Name (e.g., Fairfax). | String | no | no | |
PostalCode | Post Office Code number. | StringLength1to16 | no | no | |
StateProv | State or Province name (e.g., Texas).State, province, or region name or code needed to identify location. | String | no | no | |
CountryName | Country name (e.g., Ireland).The name or code of a country (e.g. as used in an address or to specify citizenship of a traveller). | String | no | no | |
Code | ISO 3166 code for a country. | String | |||
Phones | Provides detailed phone information. | no | no | ||
Phone | Used to pass detailed phone information. | yes | yes | ||
AreaCityCode | Code assigned for telephones in a specific region, city, or area. | NumericStringLength1to8 | |||
CountryAccessCode | Code assigned by telecommunications authorities for international country access identifier. | NumericStringLength1to3 | |||
DefaultInd | When true, indicates a default value should be used. | Boolean | |||
Extension | Extension to reach a specific party at the phone number. | NumericStringLength1to5 | |||
FormattedInd | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. | Boolean | |||
PhoneLocationType | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). | OTA_CodeType | |||
PhoneNumber | Telephone number assigned to a single location. | StringLength1to32 | |||
PhoneTechType | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). | OTA_CodeType | |||
PhoneUseType | Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Refer to OpenTravel Code List Phone Use Type (PUT). | OTA_CodeType | |||
PIN | Additional codes used for pager or telephone access rights. | StringLength1to8 | |||
Remark | A remark associated with the telephone number. | StringLength1to128 | |||
RPH | Used elsewhere in the message to reference a specific telephone number (including faxes). | NonNegativeInteger | |||
ShareMarketInd | Permission for sharing data for marketing purposes. | Sharing_Type | |||
ShareSynchInd | Permission for sharing data for synchronization of information held by other travel service providers. | Sharing_Type | |||
ID | The ID attribute in this group is a unique identifying value assigned by the creating system and may be used to reference a primary-key value within a database or in a particular implementation. | StringLength1to32 | |||
Emails | A collection of email elements. | yes | no | ||
Electronic email addresses, in IETF specified format. | yes | no | |||
EmailType | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). | OTA_CodeType | |||
Remark | A remark associated with the e-mail address. | StringLength1to128 | |||
RPH | Used elsewhere in the message to reference this specific email address. | NonNegativeInteger | |||
TextFormat | Preferred email format. | String | |||
ValidInd | Valid email address indicator. | Boolean | |||
DefaultInd | Identifies whether or not this is the default email address. | Boolean | |||
ShareMarketInd | Permission for sharing data for marketing purposes. | Sharing_Type | |||
ShareSynchInd | Permission for sharing data for synchronization of information held by other travel service providers. | Sharing_Type | |||
CompanyName | The name of the company with which this contact is associated. | no | no |
Use cases
Use case #1: Complete contact
<ContactInfos> <ContactInfo ContactProfileID="00155e849547ef99" ContactProfileType="6" Location="0" Removal="0"> <Names> <Name Language="fr" ShareMarketInd="Inherit" ShareSynchInd="Inherit"> <NamePrefix>Mr.</NamePrefix> <GivenName>Fabio</GivenName> <Surname>Crescenzio</Surname> <JobTitle>Dev</JobTitle> </Name> </Names> <Phones> <Phone CountryAccessCode="41" PhoneNumber="123456789" PhoneTechType="1" PhoneUseType="5" ShareMarketInd="Inherit" ShareSynchInd="Inherit" ID="00155e8495480614"/> <Phone CountryAccessCode="41" PhoneNumber="123456789" PhoneTechType="3" PhoneUseType="5" ShareMarketInd="Inherit" ShareSynchInd="Inherit" ID="00155e8495480ccf"/> <Phone CountryAccessCode="41" PhoneNumber="123456789" PhoneTechType="5" PhoneUseType="5" ShareMarketInd="Inherit" ShareSynchInd="Inherit" ID="00155e8495481323"/> </Phones> <Emails> <Email EmailType="2" TextFormat="text/html" ShareMarketInd="Inherit" ShareSynchInd="Inherit">fabio.crescenzio@hotel-spider.com</Email> </Emails> <CompanyName>Hotel-Spider</CompanyName> </ContactInfo> </ContactInfos>
Use case #2: An incomplete contact
<ContactInfos> <ContactInfo ContactProfileID="00155e849547ef99" ContactProfileType="6" Location="0" Removal="0"> <Names> <Name Language="fr" ShareMarketInd="Inherit" ShareSynchInd="Inherit"> <GivenName>Fabio</GivenName> </Name> </Names> <Phones> <Phone CountryAccessCode="41" PhoneTechType="1" PhoneUseType="5" ShareMarketInd="Inherit" ShareSynchInd="Inherit" ID="00155e8495480614"/> </Phones> <Emails> <Email EmailType="2" TextFormat="text/html" ShareMarketInd="Inherit" ShareSynchInd="Inherit"></Email> </Emails> <CompanyName>Hotel-Spider</CompanyName> </ContactInfo> </ContactInfos>