RestGuestProfile

From HTNG Connectivity Wiki

Jump to: navigation, search

Contents

Profile

This version of the Guest profile is based on the data sent in the OTA_HotelAvailRQ message and is not based on the HTNG_ProfileReadRQ message.

Operations

GET guestID
returns the guest profile based on the provided guestID

Attributes

Name
Detailed name information for the customer. Follows Person Name utility object schema.
Document
Document information for verification purposes and also used for additional filtering for common names.
PhoneNumbers[Telephone]
Information on a telephone number for the customer. Follows Telephone utility object schema.
EmailAddresses[Email]
Information on an email address for the customer. Follows Email utility object schema.
Addresses[Address]
Detailed information on an address for the customer. Follows Address utility object schema.
URL[String]
Information on a URL for the customer.
CitizenCountryCode
Name of the (self-professed) country that is claimed for citizenship using ISO 3166-1 alpha-2 value.

Things to Consider

Social Handles
Information on social profiles for the customer (LinkedIn, Twitter, Facebook, etc). May be broken down into utility which captures specific identifiers and components of the profile. (ID, @mention, URI, etc).
URL Types
Should we consider extracting URL to a utility object that captures more detail around the context of the URL.

References

Notes

The specification that would be replicated in a JSON format would be: HTNG Customer Profile 2014B Specification - https://collaboration.htng.org/specs/documents.php?action=show&dcat=54&gdid=26571

The message in the spec is:

HTNG_ReadRQ / ReadRequests / ProfileReadRequest

with alot of data points beneath it - such as: Customer Name, location details, type, etc Which I would see turning into a rest endpoint by guest profile ID or some other unique identifier.

FWIW - here is an example of how RoomKey serves up this data from their API: https://roomkeyapi.azurewebsites.net/hotels/Hotel_1-1/guests/111?Key=ApiKey_1 (it can be sent as XML or JSON)

Personal tools
administrative tools