...
Name | Contents | ||
---|---|---|---|
AGNCY_INFO | Agency information:
| ||
CONTACT_DATA | Company contact data:
| ||
PARENT_COMPANY | Parent company settings:
| ||
MEMBERSHIPS | Corporate alliance Memberships
| ||
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:
| ||
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
| ||
INTERFACE_SETUP |
| ||
TRAVELLER_SETTINGS |
| ||
GENERAL_SETTINGS |
|
Get subsidiaries of a company profile
Scope | api.profilesondemand.write |
---|---|
Endpoint | api/v1/profiles/company/<uuid>/subsidiaries |
Request method | GET |
Query subsidiaries for a given company
Parameters
Name | Description | Validation |
---|---|---|
uuid | The company UUID for which subsidiaries should be queried | Mandatory parameter |
Code Block | ||||
---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \
"https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/company/b9321d7e-9d72-4e80-ac49-d3aa38169175/subsidiaries" |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"uuid": "da5a20c7-08db-42ae-a5e7-72737e9eb647",
"name": "Hierarchy Child Company 2"
},
{
"uuid": "2b8c21de-8e74-4d8d-b836-e904e4977c61",
"name": "Hierarchy Child Company 1"
}
] |
Create new company profile
...
Create a new company profile
Parameters
Name | Description | Validation |
---|---|---|
returnAddSections | List of additional profile sections which should be included in the response, even if not modified by the current operation | Optional parameter (GET) |
...
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 |
returnAddSections | List of additional profile sections which should be included in the response, even if not modified by the current operation | Optional parameter (GET) |
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 generic values from a profile, please include the field uuid or name but set the field content to empty.
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 |
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:
|
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:
|
Code Block | ||||
---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \ "https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/travellers?q=bob&page=0&pageSize=10" |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "moreResults": false, "results": [{ "uuid": "065fe9e0-47b7-4d12-b3de-d3aa38169175", "fullName": "Herr Bob Builder" }] } |
Anchor | ||||
---|---|---|---|---|
|
Scope | api.profilesondemand.read |
---|---|
Endpoint | api/v1/profiles/traveller/<uuid> |
Request method | GET |
Parameters
Name | Description | Validation | ||
---|---|---|---|---|
<uuid> | The UUID of the profile to retrieve | Required parameter | ||
sections | Areas of the profile to be returned. Must be used to reduce the amount of data transferred
| Optional |
...
Create a new traveler profile
Parameters
Name | Description | Validation |
---|---|---|
returnAddSections | List of additional profile sections which should be included in the response, even if not modified by the current operation | Optional parameter (GET) |
...
Updates (part of) the details of a single traveler profile.
Parameters
Name | Description | Validation |
---|---|---|
<uuid> | The UUID of the profile to update | Required parameter |
returnAddSections | List of additional profile sections which should be included in the response, even if not modified by the current operation | Optional parameter (GET) |
...
Delete a single traveler profile from Faces as well as all downline systems.
Parameters
Name | Description | Validation |
---|---|---|
<uuid> | The UUID of the profile to delete | Required parameter |
...
Fetch plaintext credit card data from a company or traveler profile.
Parameters
Name | Description | Validation |
---|---|---|
uuid | Owning (company / traveler) profile UUID | Required parameter |
ccUuid | Specific credit card UUID as obtained from the CREDIT_CARDS section of the profile. See: Company profile sections overview, Traveler profile sections overview | Required parameter |
...
Fetch the generic setup of a travelagency tailored to the access level of the calling user / application
Parameters
Name | Description | Validation |
---|---|---|
<uuid> | The UUID of the travelagency | Required parameter |
profileType | May be used to restrict the response to configuration for a specific profile type. | OptionalOne of TRAVELLER, CORPORATE
|
...
Fetch the generic setup of a company tailored to the access level of the calling user / application
Parameters
Name | Description | Validation |
---|---|---|
<uuid> | The UUID of the company | Required parameter |
merged | Defines wheter to include only the company setup (false) or merge it with the underlying agency setup (true) | Boolean value: true or false Optional, default: false |
profileType | May be used to restrict the response to configuration for a specific profile type. | Optional One of TRAVELLER, CORPORATE |
...
Fetch a list of available frequent flyer options
Parameters
Name | Description | Validation |
---|---|---|
profileType | Some options are only available on COPORATE level but no on TRAVELLER profiles. This parameter allows to query the valid options per profile type | Optional parameter:
Will return all frequent flyer options (unfiltered) if omitted |
...
Fetch a list of known rail card types
Parameters
Name | Description | Validation |
---|---|---|
agency | Allows specifying an agency UUID for which the supported rail card types should be listed. Depending on the agency setup the available types may differ | Optional Parameter Will return all card types if omitted |
...