Versions Compared

Key

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

...

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:

  • gender

  • title

  • language

  • Phones (businessPhone, privatePhone, mobilePhone)

  • email

  • birhtdate

  • nationality

GENERIC_VALUES

DEPRECATED - use GENERIC_FIELD_VALUES instead

Values (where filled) from the generic setup, output as key-value pairs where the key is the fieldname and the value, the value entered on the profile.

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

...