Page History

...

Name	Description	Validation
q	Freetext query for finding matching profiles	Required parameter
page	Current page within the result set, starts at 0	Optional, number >= 0
pageSize	Maximum number of results per page. Default 10	Optional, number > 0 and <= 100
scope	Search scope	Optional, may be one of: DEFAULT (Applies default search options as is within the Faces UI) SHORTNAME (To look for profiles with a specific shortname set; partial matches are returned) EXTERNAL_NR (To look for profiles with a specific externalNr set; only exact matches are returned) GENERIC_FIELD (To look in a specific field from the agencies generic setup) RECORD_LOCATOR (To look for profiles with matching record locator only)
p	Search scope parameter	Required if scope=GENERIC_FIELD: Name of the generic field to search in Optional for scope=RECORD_LOCATOR: System type or Label (e.g. “CSX”, “GALILEO_WS”, “My HR-System”) Prohibited otherwise
detailSections	Specify additional profile areas to be returned if includeDetails is set to true. Only explicitly specified sections will be included.	Only the following sections are currently supported: AGENCY_INFO CONTACT_DATA HISTORY

Code Block

language	bash
title	Example Request

curl -v -H "Authorization: Bearer <token>" \
    "https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/companies?q=acme&page=0&pageSize=10"

...

Name	Contents
AGNCY_INFO	Agency information: uuid name
CONTACT_DATA	Company contact data: street street2 zipCode place countryCode phone fax E-Mail (email, email2, email3)
MEMBERSHIPS	Corporate alliance Memberships airline alliance (2-Letter code) memberNumber type hotel alliance (2-Letter code) memberNumber rentalCar alliance (2-Letter code) memberNumber
GENERIC_VALUES	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.
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
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 - Everything in order, no special state) SOFT_FAULT - Profile is in a "desired" fault state (Publishing rejected / Profile processed by remote endpoint with warnings) HARD_FAULT - Profile is in a fault state which cannot be resolved simply be re-publishing it (without any change to agency setup or manual profile safe)

Create new company profile

...

Scope	api.profilesondemand.write
Endpoint	api/v1/profiles/company/<uuid>
Request method	PATCH

Updates (part of) the details of a single company profile.

Parameters

Name	Description	Validation
<uuid>	The UUID of the profile to update	Required parameter

Code Block

curl -v -X PATCH \
    -H "Authorization: Bearer <token>" \
    -H "Content-Type: application/json" \
    --data '{
    "externalNr": "0815",
    "name": "ACME Incorporated",
    "shortname": "ACME-INC",
    "data": {
        "memberships": {
            "airline": [{
                "alliance": "LH",
                "memberNumber": "DEMODEMO123",
                "type": "SPECIAL_KEYWORD"
            }]
        }
    }
}' https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/company/b9321d7e-9d72-4e80-ac49-d3a

Implementation notes

Depending on the authorization level of the caller, it may not be possible to edit certain properties. Changes to unmodifiable properties will be silently ignored if sent.

Callers should include only the properties they wish to edit in the PATCH request. Due to underlying synchronization logic to third party systems, it is required to perform all profile modifications within one single PATCH call (I.e. do not first edit the shortname, then add a membership code as two separate API calls).

The following logic is applied when editing collections, such as memberships to allow for modification of single elements within the collection without having separate API calls for that purpose:

If an “uuid” is supplied, the corresponding collection element is being modified

If there is no matching element with the given UUID, the update is ignored

In order to remove a collection item, it’s UUID is supplied, along with a property “_operation”, which is set to “remove”

In order to remove genericValues from a profile, please include the fieldname but set the field content to empty or null.

Delete company profile

Scope	api.profilesondemand.write
Endpoint	api/v1/profiles/company/<uuid>
Request method	DELETE

Delete a single company profile (along with all associated traveler profiles) from Faces as well as all downline systems.

Parameters

Name	Description	Validation
<uuid>	The UUID of the profile to delete	Required parameter

Code Block
curl -v -X DELETE \ -H "Authorization: Bearer <token>" \ https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/company/b9321d7e-9d72-4e80-ac49-d3aa38169175

Example response

HTTP 204 “No Content” with empty body

Search traveler profile

Scope	api.profilesondemand.read
Endpoint	api/v1/profiles/travellers
Request method	GET

Allows searching through a paged list of traveler profiles

Parameters

Name	Description	Validation
q	Freetext query for finding matching profiles	Required parameter
page	Current page within the result set, starts at 0	Optional, number >= 0
pageSize	Maximum number of results per page. Default 10	Optional, number > 0 and <= 100
c	Narrow down the search for travelers attached to a specific company profile	Optional, company UUID
scope	Search scope	Optional, may be one of: DEFAULT (Applies default search options as is within the Faces UI) EMAIL (To look for profiles with matching E-Mail only - must be an exact match) USERNAME (To look for profiles with matching Username only - must be an exact match) GENERIC_FIELD (To look in a specific field from the agencies generic setup) RECORD_LOCATOR (To look for profiles with matching record locator only) PAPER (to look for profiles with a matching paper, e.g. a passport by number) PHONE_NUMBER (To look for profiles based on a full phone number; must be provided in international format, e.g. +41449335390) Note: Please make sure to properly encode the "+" within the query string (as %2B) and do not include any formatting in the number. Faces will silently fail and return zero results if the phone number is supplied in an invalid format
p	Search scope parameter	Required if scope=GENERIC_FIELD: Name of the generic field to search in Optional for scope=RECORD_LOCATOR: System type or Label (e.g. “CSX”, “GALILEO_WS”, “My HR-System”) Optional for scope=PAPER: Type of paper to search for, PASSPORT, ID_CARD or VISA Prohibited otherwise
includeDetails	Specify whether the search response should include detailed profile data	Boolean value: true or false Optional, default: false
detailSections	Specify additional profile areas to be returned if includeDetails is set to true. Only explicitly specified sections will be included.	Only the following sections are currently supported: COMPANY_INFO GENERAL_DATA PREFERENCES ROLES HISTORY

Code Block

language	bash
title	Example request

curl -v -H "Authorization: Bearer <token>" \
    "https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/travellers?q=bob&page=0&pageSize=10"

Code Block

language	js
title	Example response

{
	"moreResults": false,
	"results": [{
		"uuid": "065fe9e0-47b7-4d12-b3de-d3aa38169175",
		"fullName": "Herr Bob Builder"
	}]
}

Anchor
GetTravelerProfile
GetTravelerProfile
Get traveler profile

Scope	api.profilesondemand.read
Endpoint	api/v1/profiles/traveller/<uuid>
Request method	GET

Retrieves the details of a single traveler profile.

...

Name

Contents

COMPANY_INFO

Information on the associated company:

UUID
name
Customer number (externalNr)

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:

gender
title
language
Phones (businessPhone, privatePhone, mobilePhone)
email
birhtdate
nationality

GENERIC_VALUES

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.

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:

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
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 - Everything in order, no special state)
SOFT_FAULT - Profile is in a "desired" fault state (Publishing rejected / Profile processed by remote endpoint with warnings)
HARD_FAULT - Profile is in a fault state which cannot be resolved simply be re-publishing it (without any change to agency setup or manual profile safe)

UNUSED_TICKETS

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

carrier
expiryDate
fare
pnr
ticketNumber

Create new traveler profile

...

Versions Compared

Old Version 32

New Version 33

Key

Create new company profile

Parameters

Implementation notes

Delete company profile

Parameters

Example response

Search traveler profile

Parameters

Anchor
GetTravelerProfile
GetTravelerProfile
Get traveler profile

Create new traveler profile

Page History

Versions Compared

Old Version 32

New Version 33

Key

Create new company profile

Parameters

Implementation notes

Delete company profile

Parameters

Example response

Search traveler profile

Parameters

AnchorGetTravelerProfileGetTravelerProfileGet traveler profile

Create new traveler profile

Anchor
GetTravelerProfile
GetTravelerProfile
Get traveler profile