...
| Scope | Description |
|---|---|
| api.profilesondemand.read | Access to the Profiles API (read only) |
| api.profilesondemand.write | Access to the Profiles API (write) |
| api.profilesondemand.ccaccess | Access to plaintext credit card details. Requires attestation of PCI compliance as well as special handling for CC numbers to be exchanged via our parnter Midoco |
| api.profilesondemand.profilecenter.read | Access to (certain functions of) the Profile Center API (read only) |
| openid | Required scope when requesting an ID-Token for “Login using Faces” functionality |
| agencyid | Optional scope to be included in and ID-Token. Please see the section Usage of an ID token within this document. |
Optional scope to be included in and ID-Token. Please see the section Usage of an ID token within this document. | |
| profile | Optional scope to be included in and ID-Token. Please see the section Usage of an ID token within this document. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"groups": [
{
"uuid": "8744e74c-29c9-4009-8629-036d01d5f2cd",
"groupType": {
"@type": "integrated",
"key": "general.header_prefs"
},
"sequence": 7,
"defaultLabel": "Preferences",
"labels": {
"sv_SE": "Önskemål",
"es_ES": "Preferencias",
"fr_BE": "Préférences",
"nl_NL": "Präferenzen",
"hu_HU": "Felhasználói beállítások",
"de_CH": "Präferenzen",
"it_CH": "Preferenze",
"de_DE": "Präferenzen",
"kl_GL": "Sallinngortitat",
"cs_CZ": "Preference",
"da_DK": "Præferencer",
"pl_PL": "Preferencje",
"sk_SK": "Preferencie",
"it_IT": "Preferenze",
"pt_PT": "Präferenzen",
"fr_FR": "Préférences",
"en_US": "Preferences",
"de_AT": "Präferenzen",
"fr_CH": "Préférences",
"en_GB": "Preferences",
"nl_BE": "Präferenzen"
},
"fields": [
{
"uuid": "390c82f6-22fb-48c5-a82e-337b62a2afd8",
"name": "OptInNewsletter",
"sequence": 0,
"internalCode": "",
"profileType": "TRAVELLER",
"editable": true,
"defaultLabel": "Für Newsletter anmelden",
"labels": {
"en_US": "Opt-In to Newsletter",
"en_GB": "Opt-In to Newsletter"
},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
}
]
}
],
"standardFieldDefinitions": [
{
"uuid": "d2484146-b681-11ec-9e61-482ae368e12c",
"collectionName": null,
"fieldName": "email",
"profileType": "CORPORATE",
"affectedUserGroup": "ENTIRE_AGENCY",
"fieldDisplayType": "MANDATORY"
},
{
"uuid": "d2481a36-b681-11ec-9e60-482ae368e12c",
"collectionName": null,
"fieldName": "phoneMobile",
"profileType": "TRAVELLER",
"affectedUserGroup": "COMPANY_ADMIN_AND_TRAVELLER",
"fieldDisplayType": "MANDATORY"
},
{
"uuid": "d2486860-b681-11ec-9e62-482ae368e12c",
"collectionName": "flightmemberships",
"fieldName": "additionalinfo",
"profileType": "TRAVELLER",
"affectedUserGroup": "ENTIRE_AGENCY",
"fieldDisplayType": "HIDDEN"
},
{
"uuid": "d247cc20-b681-11ec-9e5f-482ae368e12c",
"collectionName": "hotelmemberships",
"fieldName": "alliance",
"profileType": "TRAVELLER",
"affectedUserGroup": "ENTIRE_AGENCY",
"fieldDisplayType": "MANDATORY"
}
]
} |
Anchor ProfileCenterAPI ProfileCenterAPI
Profile Center API
| ProfileCenterAPI | |
| ProfileCenterAPI |
This API allows access to "Profile Center" functions of Umbrella Faces
Get publish errors
| Scopes | api.profilesondemand.profilecenter.read |
|---|---|
| Endpoints | api/v1/profilecenter/corporate-publish-errors api/v1/profilecenter/traveller-publish-errors |
| Request method | GET |
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 |
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \
"https://hurricane.umbrellanet.ch/uf-test/api/v1/profilecenter/traveller-publish-errors?since=2023-01-23T13:00:25.000Z" |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{TBD} |
System reference data API
...
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 |
...