...
The interface is part of our standard web service offering and can be found in our swagger documentation.
| View file | ||||
|---|---|---|---|---|
|
| Panel | ||||
|---|---|---|---|---|
| ||||
|
...
It is important to note that the commonTitle is mandatory whenever sex is set to MALE or FEMALE if the agency is using Title Structure "Default".
Should you create / update a profile using compoundTitle, you might still get an errorMessage for greeting.commonTitle in case the supplied compoundTitle can not be derived into a valid commonTitle.
Get linked
...
traveler profiles
Anchor TravelerGreetingStructure TravelerGreetingStructure
Arranger
| TravelerGreetingStructure | |
| TravelerGreetingStructure |
| Scope | api.profilesondemand.read |
|---|---|
| Endpoint | api/v1/traveller/<uuid>/arranger-contacts |
| Request method | GET |
Query returns an array of travellers travelers where the specified uuid is linked as an arranger.
Parameters
| Name | Description | Validation |
|---|---|---|
| uuid | The profile UUID for which you want to get a list of travellers where profile is selected as arranger | Mandatory parameter |
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \
"https://hurricane.umbrellanet.ch/uf-test/api/v1/traveller/065fe9e0-47b7-4d12-b3de-d3aa38169175/arranger-contacts" |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"displayText": "Mr. Bob Example",
"contactUuid": "4cc19e19-11f4-46c3-b4f6-1ee2360a5752"
},
{
"displayText": "Mrs. Jane Never",
"contactUuid": "9a57f51b-1b7b-43cd-8582-d909670682aa"
}
] |
| Anchor | ||||
|---|---|---|---|---|
|
| Scope | api.profilesondemand.read |
|---|---|
| Endpoint | api/v1/traveller/<uuid>/approver-contacts |
| Request method | GET |
Query returns an array of travellers travelers where the specified uuid is linked as an approver.
Parameters
| Name | Description | Validation |
|---|---|---|
| uuid | The profile UUID for which you want to get a list of travellers where profile is selected as approver | Mandatory parameter |
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \
"https://hurricane.umbrellanet.ch/uf-test/api/v1/traveller/065fe9e0-47b7-4d12-b3de-d3aa38169175/approver-contacts" |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"displayText": "Mr. Bob Example",
"contactUuid": "4cc19e19-11f4-46c3-b4f6-1ee2360a5752"
},
{
"displayText": "Mrs. Jane Never",
"contactUuid": "9a57f51b-1b7b-43cd-8582-d909670682aa"
}
] |
Create new traveler profile
...
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 publishing errors
Parameters
| Name | Description | Validation |
|---|---|---|
| page | Current page within the result set, starts at 0 | Optional, number >= 0 |
| pageSize | Maximum number of results per page. Default 25 | Optional, number > 0 and <= 100 |
| since | Restrict results to errors that have occurred on or after a specific timestamp | Optional Format yyyy-MM-dd'T'HH:mm[:ss[.SSS]]X |
...
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 |
...