...
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. |
...
Name | Contents |
---|---|
COMPANY_INFO | Information on the associated company:
|
COMPANY_CONTACT_DATA | Contact information of the associated company (read only, provided for simplicity / reduce the need to talk to the company endpoint):
|
GENERAL_DATA | General profile information:
|
GENERIC_FIELD_VALUES | Values (where filled) from the generic setup
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:
|
PASSPORT | Passport(s) as shown in Faces UI |
VISA | Visa information as shown in Faces UI |
ID_CARD | Identification Cards as shown in Faces UI |
EMERGENCY_CONTACT | Emergency contact:
|
ARRANGER_CONTACTS | Arranger contact(s):
|
APPROVER_CONTACTS | Approver contact(s):
|
ROLES | Roles as show in Faces UI with the respective checkboxes (true/false):
|
PREFERENCES | Preferences:
|
CREDIT_CARDS | Credit card related information:
|
RAIL_INFORMATION | Rail related information - only available if rail feature is active in agency configuration
|
RESIDENT_INFORMATION | (Spanish) Resident Information - only available if spanish resident feature is active in agency configuration
|
TRAVEL_GROUP_ASSIGNMENTS | Travel group assignments - will only be populated if profile is synchronized to Cytric:
|
COMMENT | Comment on profile - only available to agency managers |
HISTORY | History (Read Only):
|
PUBLISH_STATES | Publish States (Read Only):
The Fault indicator will be one of
|
UNUSED_TICKETS | Unused ticket information - only available if Magnatech is active on agency (Read Only):
|
Anchor TravelerGreetingStructure TravelerGreetingStructure
Traveler "greeting" structure handling
TravelerGreetingStructure | |
TravelerGreetingStructure |
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:
|
Using compoundTitle vs commonTitle & formalTitle
TBD
Create new traveler profile
...