Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

As the name suggests, the Profiles On Demand API is designed to provide profiles on demand.

It is specifically prohibited to run bulk queries for profiles aimed at dumping / synchronizing the full profile data base to a third party system.

...

NameContents
COMPANY_INFOInformation on the associated company:
  • UUID

  • name (read only)

  • Customer number (externalNr, read only)

COMPANY_CONTACT_DATA

Contact information of the associated company (read only, provided for simplicity / reduce the need to talk to the company endpoint):

  • Address (street, street2, zipCode, place, countryCode)

  • phone

  • fax

  • E-Mail (email, email2, email3)

GENERAL_DATA

General profile information:

GENERIC_FIELD_VALUES

Values (where filled) from the generic setup

  • field (name, uuid)
  • value

Note: Updates to generic field values are possible using either the field name or field uuid. Using the uuid is preferred since it is guaranteed to be unique, whereas name may not be unique or simply not set in some edge cases.

MEMBERSHIPS

Flight, Hotel and Rentalcar-Memberships with:

  • alliance-code
  • membernumber
  • pin (Flight memberships only)
PASSPORTPassport(s) as shown in Faces UI
VISAVisa information as shown in Faces UI
ID_CARDIdentification Cards  as shown in Faces UI
EMERGENCY_CONTACT

Emergency contact:

  • firstname, lastname

  • phone

  • email

ARRANGER_CONTACTS

Arranger contact(s):

  • displayText
  • contactUuid: (Referenced Traveller UUID) - may be empty in case Faces is still awaiting the profile to be delivered rom an external system
APPROVER_CONTACTS

Approver contact(s):

  • displayText
  • contactUuid: (Referenced Traveller UUID) - may be empty in case Faces is still awaiting the profile to be delivered from an external system
ROLES

Roles as show in Faces UI with the respective checkboxes (true/false):

  • traveller

  • arranger

  • approver

PREFERENCES

Preferences:

  • smoker

  • preferredSeat (A or W)

  • preferredFood (4-Letter code)

CREDIT_CARDS

Credit card related information:

  • creditCards
    • type (DC, AX, VI, CA, TP, JC, DS)
    • maskedNumber
    • expiratoin
    • remark
    • publishAsFop
    • nameOnCard
  • webCard reference
  • hotelGuarantee reference
  • carGuarantee reference
  • railFormOfPayment reference - only available if rail feature is active in agency configuration
RAIL_INFORMATION

Rail related information - only available if rail feature is active in agency configuration

  • preferredClass
  • preferredSeat (A or W)
  • railCards
    • type
    • number
    • expiration
    • class
    • collectBonusPoints
    • validFromStation
    • validToStation
RESIDENT_INFORMATION

(Spanish) Resident Information - only available if spanish resident feature is active in agency configuration

  • area

  • areaCode

  • cardType

  • cardNumber

  • firstname

  • firstSurname

  • secondSurname

TRAVEL_GROUP_ASSIGNMENTS

Travel group assignments - will only be populated if profile is synchronized to Cytric:

  • groupId (Note: Will be the same for all group assignments)
  • role
COMMENTComment on profile - only available to agency managers
HISTORY

History (Read Only):

  • lastModified (timestamp)
  • history (Only available to agency managers)
PUBLISH_STATES

Publish States (Read Only):

  • label
  • lastPublished (timestamp)
  • recordLocator
  • lastPublishState
  • faultIndicator

The Fault indicator will be one of

  • OK (Everything in order, no special state)
  • QUEUED (Everything in order, but profile is currently queued for publishing)
  • INTENTIONALLY_NOT_PUBLISHED (Profile is in a "desired" fault state (Publishing rejected / Profile processed by remote endpoint with warnings))
  • TIMESTAMP_ISSUE (Profile has an error which is based on timestamp mismatches)
  • GENERAL_ERROR (The publish state is in error.)
UNUSED_TICKETS

Unused ticket information - only available if Magnatech is active on agency (Read Only):

  • carrier
  • expiryDate
  • fare
  • pnr
  • ticketNumber

Anchor
TravelerGreetingStructure
TravelerGreetingStructure
Traveler "greeting" structure handling

Umbrella Faces logically divides a greeting into common title and formal title. The common title is restricted to a predefined list (please see the swagger document for the most up to date list), whereas the formal title allows storage of freetext title information with the limitation of only showing certain formal titles in the UI.

 

Note

Depending on the travel agency setup, not all combinations of common / formal title are supported by the Faces UI. It's best to consult with the travel agency on their setup to ensure a consistent user experience.

The common titles referenced in the swagger definition are generally valid for every agency

Please refer to the following tables:

Expand
titleFormal Titles
Formal TitleTitle Structure "Default"Title Structure "Compound" *
Master(error) Not supported(tick) Supported
Mx(error) Not supported(tick) Supported
DR(tick) Supported(tick) Supported
PROF(tick) Supported(tick) Supported 
Rev(error) Not supported(tick) Supported
Sir(error) Not supported(tick) Supported
Lord(error) Not supported(tick) Supported
Lady(error) Not supported(tick) Supported

* Titles are supported, if no commonTitle is set. Since for "Compound" the UI is only using a single drop-down it is not possible to display a title such as MR DR

Using compoundTitle vs commonTitle & formalTitle

TBD

 

Create new traveler profile

...