GenHTNG - Profile Lookup

1 Overview
2 Supported Operations
3 Business Rules
4 OTA_ReadRQ-ProfileLookUpByID Elements & Attributes
5 OTA_ReadRQ-ProfileLookUpByID Sample
6 ReadRQ-ProfileSearch Elements & Attributes
7 ReadRQ-ProfileSearch Sample
8 OTA_ProfileReadRS Elements & Attributes
9 OTA_ProfileReadRS Sample

Overview

OTA_ReadRQ allows for a query of profiles either by ID number, or some combination of name, address or email in order to retrieve matching guest profiles from Maverick CRM. This is useful when creating reservations within the PMS directly in order to pull existing guest profiles vs creating new records. This profile lookup functionality will allow users to download the profile in which to begin building the Reservation.

Supported Operations

PMS can Lookup by Maverick Profile ID number in CRM
PMS can Lookup profiles by name, address or Email in CRM
PMS can download returned profile to use in the reservation process

Business Rules

This message is from PMS to CRM
When searching by last name, at least 3 characters must be sent
Last name or email is required (Mandatory).

OTA_ReadRQ-ProfileLookUpByID Elements & Attributes

Element \| @Attribute	Num	Description/Contents	Origin \| Value
OTA_ReadRQ/ReadRequests/UniqueID/	1	Root element of the message.
@Type	1	Refer to OpenTravel Code List Unique ID Type (UIT).	Always should be “1“
@ID	1	Maverick Profile ID number

OTA_ReadRQ-ProfileLookUpByID Sample

<?xml version='1.0' encoding='UTF-8'?>
<n1:Envelope xmlns:n1="http://www.w3.org/2003/05/soap-envelope" xmlns:n3="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:n2="http://www.w3.org/2005/08/addressing" xmlns:n4="http://htng.org/PWSWG/2007/02/AsyncHeaders">
    <n1:Header>
        <n2:MessageID>{{MessageID}}</n2:MessageID>
        <n4:CorrelationID>2b36432943304e8d81ba5618d5df9e5a</n4:CorrelationID>
        <n2:Action>http://htng.org/PWSWG/2010/12/ReadRequest</n2:Action>
        <n2:To>https://uat.windsurfercrs.com/pms/genhtngservice.aspx</n2:To>
        <n2:ReplyTo>
            <n2:Address>http://www.w3.org/2005/08/addressing/role/anonymous</n2:Address>
        </n2:ReplyTo>
        <n3:Security mustUnderstand="1">
            <n3:UsernameToken>
                <n3:Username>{{HeaderUserName}}</n3:Username>
                <n3:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{{HeaderPassword}}</n3:Password>
            </n3:UsernameToken>
        </n3:Security>
        <n4:ReplyTo>
            <n2:Address>https://pmsendpoint/serviceEndpoint</n2:Address>
        </n4:ReplyTo>
    </n1:Header>
    <n1:Body>
        <OTA_ReadRQ xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" EchoToken="{{EchoToken}}" TimeStamp="{{CurrentDateTime}}" xmlns="http://www.opentravel.org/OTA/2003/05">
            <ReadRequests>
                  <UniqueID Type="1" ID="200354189"/>
        </OTA_ReadRQ>
    </n1:Body>
</n1:Envelope>

ReadRQ-ProfileSearch Elements & Attributes

Element \| @Attribute	Num	Description/Contents	Origin \| Value
OTA_ReadRQ	1	Root element of the message.
OTA_ReadRQ/ReadRequests/ProfileReadRequest
@ProfileTypeCode	1	Refer to OpenTravel Code List Profile Type (PRT)	Always should be “1“
OTA_ReadRQ/ReadRequests/ProfileReadRequest/Customer/PersonName/		Detailed name information for the customer.This provides name information for a person.
@GivenName	0..1	Guest First Name
@Surname	1	Guest Last Name
OTA_ReadRQ/ReadRequests/ProfileReadRequest/Customer/Email/		Information on an email address for the customer.
@EmailType	0..1	Refer to OpenTravel Code List Email Address Type (EAT).	Not Mapped
@DefaultInd	0..1	When true, indicates a default value should be used.	Not Mapped
Value	1	Email address
OTA_ReadRQ/ReadRequests/ProfileReadRequest/Customer/Address/		Detailed information on an address for the customer.
@DefaultInd	0..1	When true, indicates a default value should be used.	Not Mapped
@Type	0..1	Refer to OpenTravel Code List Communication Location Type (CLT).	Not Mapped
@AddressLine	0..1	Street Address
@CityName	0..1	City
@PostalCode	0..1	Postal/Zip Code
StateProv @StateCode	0..1	State Code
CountryName @Code	0..1	Country Code
OTA_ReadRQ/ReadRequests/ProfileReadRequest/Customer/CustLoyalty		Loyalty program information for the customer.
@MembershipID	0..1	Unique identifier of the member in the program

ReadRQ-ProfileSearch Sample

<?xml version='1.0' encoding='UTF-8'?>
<n1:Envelope xmlns:n1="http://www.w3.org/2003/05/soap-envelope" xmlns:n3="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:n2="http://www.w3.org/2005/08/addressing" xmlns:n4="http://htng.org/PWSWG/2007/02/AsyncHeaders">
    <n1:Header>
        <n2:MessageID>{{MessageID}}</n2:MessageID>
        <n4:CorrelationID>2b36432943304e8d81ba5618d5df9e5a</n4:CorrelationID>
        <n2:Action>http://htng.org/PWSWG/2010/12/ReadRequest</n2:Action>
        <n2:To>https://uat.windsurfercrs.com/pms/genhtngservice.aspx</n2:To>
        <n2:ReplyTo>
            <n2:Address>http://www.w3.org/2005/08/addressing/role/anonymous</n2:Address>
        </n2:ReplyTo>
        <n3:Security mustUnderstand="1">
            <n3:UsernameToken>
                <n3:Username>{{HeaderUserName}}</n3:Username>
                <n3:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{{HeaderPassword}}</n3:Password>
            </n3:UsernameToken>
        </n3:Security>
        <n4:ReplyTo>
            <n2:Address>https://pmsendpoint/serviceEndpoint</n2:Address>
        </n4:ReplyTo>
    </n1:Header>
    <n1:Body>
        <OTA_ReadRQ xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" EchoToken="{{EchoToken}}" TimeStamp="{{CurrentDateTime}}" xmlns="http://www.opentravel.org/OTA/2003/05">
            <ReadRequests>
                <ProfileReadRequest ProfileTypeCode="1">
                    <Customer>
                        <PersonName>
                            <GivenName>org</GivenName>
                            <Surname>test</Surname>
                        </PersonName>
                    <Email EmailType="1" DefaultInd="true">test@shr.global</Email>
                    <Address DefaultInd="true" Type="HOME">
                        <AddressLine>55497 Central Drive</AddressLine>
                        <CityName>San Felipe</CityName>
                        <PostalCode>77473</PostalCode>
                        <StateProv StateCode="TX"/>
                        <CountryName Code="US"/>
                    </Address>
                    </Customer>
                </ProfileReadRequest>
            </ReadRequests>
        </OTA_ReadRQ>
    </n1:Body>
</n1:Envelope>

OTA_ProfileReadRS Elements & Attributes

Element \| @Attribute	Num	Description/Contents	Origin \| Value
OTA_ProfileReadRS	1	Root element of the message.
OTA_ProfileReadRS/Profiles/ProfileInfo/UniqueID/
@Type	1	Refer to OpenTravel Code List Unique ID Type (UIT).	Always “1“
@Instance	0		Empty
@ID	1	Maverick Profile ID.
@ID_Context	1	Used to identify the source of the identifier.	“CRM”
OTA_ProfileReadRS/Profiles/ProfileInfo/Profile/
@ProfileType	1	Refer to OpenTravel Code List Profile Type (PRT).	“Customer”
@StatusCode	1	Status of the profile. Refer to OpenTravel Code List Profile Status Code (PST)	Active=”4” and InActive=”5”
OTA_ProfileReadRS/Profiles/ProfileInfo/Profile/Customer/PersonName		Detailed name information for the customer.This provides name information for a person.
@GivenName	0..1	first name or names.
@MiddleName		The middle name of the person name
@Surname	0..1	Family name, last name
OTA_ProfileReadRS/Profiles/ProfileInfo/Profile/Customer/Telephone/	0..n	Information on a telephone number for the customer.
@PhoneTechType	0	Refer to OpenTravel Code List Phone Technology Type (PTT).	Always “1“
@PhoneUseType	0	Refer to OpenTravel Code List Phone Use Type (PUT).	Always “1
@PhoneNumber	0	Telephone number
@FormattedInd	0	Specifies if the associated data is formatted or not.	Always “0“
@DefaultInd	0	When true, indicates a Primary telephone.
OTA_ProfileReadRS/Profiles/ProfileInfo/Profile/Customer/Email/	0..n	Information on an email address for the customer.
@ShareMarketInd	0	Permission for sharing data for marketing purposes.
@EmailType	0	Refer to OpenTravel Code List Email Address Type (EAT).
@DefaultInd	0	When true, indicates a Primary email address.
OTA_ProfileReadRS/Profiles/ProfileInfo/Profile/Customer/Address	0..n	Detailed information on an address for the customer.
@AddressLine	0..4	Street Address
@CityName	0..1	City
@PostalCode	0..1	Post Office Code number.
StateProv @StateCode	0..1	State Code
CountryName @Code	0..1	County Code
@DefaultInd	0	When true, indicates a Primary address.

OTA_ProfileReadRS Sample

<OTA_ProfileReadRS xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" EchoToken="1" TimeStamp="2021-01-05T09:35:56.4790162Z" Version="0" xmlns="http://www.opentravel.org/OTA/2003/05">
	<Profiles>
		<ProfileInfo>
			<UniqueID Type="1" Instance="MAVERICK" ID="200354701" ID_Context="CRM" />
			<Profile ProfileType="Customer" StatusCode="4">
				<Customer>
					<PersonName>
						<GivenName>Jerry</GivenName>
						<MiddleName>j</MiddleName>
						<Surname>chaplin</Surname>
					</PersonName>
					<Telephone PhoneTechType="0" PhoneUseType="1" PhoneNumber="2173698898" FormattedInd="0" />
					<Email ShareMarketInd="No" EmailType="1">charliechaplin@shr.global</Email>
					<Address>
						<AddressLine>210 TAYLOR LANE</AddressLine>
						<CityName>Texas</CityName>
						<PostalCode>61911</PostalCode>
						<StateProv StateCode="IL">IL</StateProv>
						<CountryName Code="US">US</CountryName>
					</Address>
				</Customer>
			</Profile>
		</ProfileInfo>
		<ProfileInfo>
			<UniqueID Type="1" Instance="MAVERICK" ID="200356816" ID_Context="CRM" />
			<Profile ProfileType="Customer" StatusCode="4">
				<Customer Gender="Male">
					<PersonName>
						<GivenName>charlie</GivenName>
						<MiddleName>j</MiddleName>
						<Surname>chaplin</Surname>
					</PersonName>
					<Telephone PhoneTechType="0" PhoneUseType="1" PhoneNumber="2173698898" FormattedInd="0" />
					<Email ShareMarketInd="No" EmailType="1">charliechaplin@shr.global</Email>
					<Address>
						<AddressLine>210 TAYLOR LANE</AddressLine>
						<CityName>Texas</CityName>
						<PostalCode>61911</PostalCode>
						<StateProv StateCode="IL">IL</StateProv>
						<CountryName Code="US">US</CountryName>
					</Address>
				</Customer>
			</Profile>
		</ProfileInfo>
	</Profiles>
	<Success />
</OTA_ProfileReadRS>