Page History

...

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

...

Code Block

language	bash
title	Example request

curl -v -X POST \
    -H "Authorization: Bearer <token>" \
    -H "Content-Type: application/json" \
    --data '{
    "username": "bob.builder",
    "firstname": "Bob",
    "middlename": "",
    "name": "Builder",
    "data": {
		"contacts": {
	        "emergencyContact": {
    	        "firstname": "Dizzy",
	            "phone": "+414412355889",
    	        "email": "dizzy@umbrella.ch",
        	    "lastname": "Mixer"
			}
        },
        "generalData": {
            "birthdate": "03.05.1973",
            "gender": "MR",
            "mobilePhone": "",
            "nationality": "CH",
            "language": "de_CH",
            "privatePhone": "",
            "businessPhone": "",
            "title": "",
            "email": "bob.builder@umbrella.ch"
        },
        "company": {
            "uuid": "52f2b2c0-4990-49bb-b1f1-d3aa38169175"
        },
        "papers": {
            "visas": [{
                    "country": "US",
                    "number": "8123789",
                    "entryType": "MULTIPLE",
                    "expiration": "01.03.2020",
                    "issueDate": "01.09.2019"
                },
                {
                    "country": "AE",
                    "number": "XXEE1123",
                    "entryType": "",
                    "expiration": "31.10.2020",
                    "issueDate": "09.03.2020"
                }
            ],
            "idCards": [{
                "country": "CH",
                "number": "123456",
                "expiration": "31.12.2030",
                "issueDate": "01.01.2020"
            }],
            "passports": [{
                    "country": "CH",
                    "number": "X12345",
                    "issueCountry": "CH",
                    "expiration": "31.12.2029",
                    "issueDate": "01.01.2019",
                    "issuePlace": "Zurich",
                    "primary": true
                },
                {
                    "country": "CH",
                    "number": "X999999",
                    "issueCountry": "CH",
                    "expiration": "31.12.2029",
                    "issueDate": "01.01.2019",
                    "issuePlace": "Zurich",
                    "primary": false
                }
            ]
        },
        "genericValues": {
            "EmailPersonal": "bob@hasnoemail.com",
            "AARPRate": "false",
            "PreferWheelchairAccess": "false",
            "MilitaryRate": "false",
            "SectionPositionCode": "Bulkhead",
            "RuleClass": "Default Travel Class"
        },
        "memberships": {
            "flight": [{
                    "alliance": "EI",
                    "memberNumber": "1199223123"
                },
                {
                    "alliance": "LH",
                    "memberNumber": "999999912317"
                }
            ],
            "rentalCar": [{
                "alliance": "EP",
                "memberNumber": "E111221"
            }],
            "hotel": [{
                    "alliance": "AL",
                    "memberNumber": "LL18675"
                },
                {
                    "alliance": "RT",
                    "memberNumber": "A123F"
                }
            ]
        }
    }
}' https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/traveller

...

Code Block

language	bash
title	Example request

curl -v -X PATCH \
    -H "Authorization: Bearer <token>" \
    -H "Content-Type: application/json" \
    --data '{
    "username": "bobby.builder",
    "firstname": "Bobby",
    "data": {
		"contacts": {
	        "emergencyContact": {
    	        "firstname": "",
        	    "phone": "",
            	"email": "",
	            "lastname": ""
			}
        },
        "generalData": {
            "birthdate": "04.05.1973",
            "email": "bobby.builder@umbrella.ch"
        },
        "papers": {
            "visas": [{
                    "country": "US",
                    "number": "8123789",
                    "entryType": "MULTIPLE",
                    "expiration": "01.03.2020",
                    "issueDate": "01.09.2019",
                    "uuid": "44f2ee67-eba5-4b29-9dfa-76e7eb97de39"
                },
                {
                    "_operation": "remove",
                    "uuid": "1eed6a49-f8e8-4441-b3ce-312f4dd1cd73"
                }
            ]
        },
        "genericValues": {
            "EmailPersonal": "bobby@hasnoemail.com"
        }
    }
}' https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/traveller/ceb545fd-5000-4f44-93dd-47a272f6f25a

...

Versions Compared

Old Version 30

New Version 31

Key