...
While the Profiles on Demand API does not currently support all data fields and entity types available in Umbrella Faces, the API is continuously being developed and extended. As a result, new data structures may be added to existing responses at any time without prior notice. It is therefore required to design a client application to only request information needed by the application as well as configure the application to not fail should there be additional (newly added) properties in the response.
| Note |
|---|
Upon examining the swagger documentation you may find more APIs not listed in this documentation. These are for internal use only and will not be made available to the general public |
Authentication
Application registration and certification
...
| Name | Contents |
|---|
| AGNCY_INFO | Agency information: |
| CONTACT_DATA | Company contact data: |
| PARENT_COMPANY | Parent company settings: - company (reference)
- adminShareOption (only relevant if parent company is set)
|
| MEMBERSHIPS | Corporate alliance Memberships airline alliance (2-Letter code) memberNumber type
hotel alliance (2-Letter code) memberNumber customerRequest
rentalCar
|
| 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 is the value entered on the profile. |
| GENERIC_FIELD_VALUES | Values (where filled) from the generic setup |
| CREDIT_CARDS | Credit card related information: - creditCards
- type (DC, AX, VI, CA, TP, JC, DS)
- maskedNumber
- expiratoin
- remark
- publishAsFop
- webCard reference
- hotelGuarantee reference
- carGuarantee reference
- railFormOfPayment reference - only available if rail feature is active in agency configuration
- additionalFormOfPayment
- travellerCardOptions
- fopOption
- hotelGuaranteeUsage
- carGuaranteeUsage
- webPaymentUsage
|
| COMMENT | Comment 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 - UNDEFINED - Default; check lastPublishState for text indication of status
- SOFT_FAULT - 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 (known) "desired" fault state (Publishing rejected / Profile processed by remote endpoint with warnings) and hence not listed in the profile center
- HARD_FAULT - Profile is in a (known) fault state which cannot be resolved simply be re-publishing it (without any change to agency setup or manual profile safe)
- )
- TIMESTAMP_ISSUE (Profile has an error which is based on timestamp mismatches)
- GENERAL_ERROR (The publish state is in error.)
|
| INTERFACE_SETUP | | Note |
|---|
This section is read only and must not be included in updates.
Sensitive properties (i.e. Concur Refresh Tokens) will not be returned by the API |
- travelGroups (only relevant for Cytric)
- targetSystems
- agencyInterface
- attribute1 (interface-specific configuration; available depending on interface type)
- attribute2 (interface-specific configuration; available depending on interface type)
- attribute3 (interface-specific configuration; available depending on interface type)
- attribute4 (interface-specific configuration; available depending on interface type)
- reportingOfficeId
- gwsAgencyLocation
|
| TRAVELLER_SETTINGS | - defaultArranger
- defaultTraveller
- selfApprovalAllowed
- approverSelectableByTraveller
|
| GENERAL_SETTINGS | - emailDelivery
- profileRemindersOption - only available if profile reminders feature is active on agency
- enableSelfRegistration - only available if self registration feature is active on agency
|
Create new company profile
...
| Name | Contents |
|---|
| COMPANY_INFO | Information on the associated company: |
| COMPANY_CONTACT_DATA | Contact information of the associated company: Address (street, street2, zipCode, place, countryCode) phone fax E-Mail (email, email2, email3)
|
| GENERAL_DATA | General profile information: |
| 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 |
| MEMBERSHIPS | Flight, Hotel and Rentalcar-Memberships with: - alliance-code
- membernumber
- pin (Flight memberships only)
|
| 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: firstname, lastname phone email
| Note |
|---|
The informaton in this section will be duplicated in JSON Path "data.emergencyContact" as well as "data.contacts.emergencyContact" Please update your implementation to only use "data.contacts.emergencyContact" - the old location "data.emgerencyContact" is deprecated and will be removed in the near future! |
|
| 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: |
| CREDIT_CARDS | Credit card related information: - creditCards
- type (DC, AX, VI, CA, TP, JC, DS)
- maskedNumber
- expiratoin
- remark
- publishAsFop
- 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
|
| COMMENT | Comment 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 - UNDEFINED - Default; check lastPublishState for text indication of status
- SOFT_FAULT - 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 (known) "desired" fault state (Publishing rejected / Profile processed by remote endpoint with warnings) and hence not listed in the profile centerHARD_FAULT - Profile is in a (known) fault state which cannot be resolved simply be re-publishing it (without any change to agency setup or manual profile safe)
- 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
|
...