...
| Note |
|---|
This API is currently under development and not yet generally available |
Get generic setup
...
for travel agency
| Scopes | api.profilesondemand.read |
|---|---|
| Endpoints | api/v1/configuration/setup/agency/{uuid} |
| Request method | GET |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \
"https://hurricane.umbrellanet.ch/uf-test/api/v1/configuration/setup/agency/TODOf4cbed76-873c-4499-be0c-f8f60745d529" |
| Code Block | ||||
|---|---|---|---|---|
| ||||
TODO | ||||
| ||||
{
"groups": [{
"groupType": "INTEGRATED",
"defaultLabel": "Your {0} team",
"labels": {
"sv_SE": "Ditt {0} team",
"es_ES": "Vuestro {0} equipo",
"fr_BE": "Votre équipe {0}",
"nl_NL": "Ihr {0} Team",
"hu_HU": "Az Ön {0} csapata",
"de_CH": "Ihr {0} Team",
"it_CH": "Vostra {0} squadra",
"de_DE": "Ihr {0} Team",
"kl_GL": "Illit {0} team-it",
"cs_CZ": "Váš {0} tým",
"da_DK": "Dit {0} team",
"pl_PL": "Twój zespół {0}",
"sk_SK": "Váš {0} tím",
"it_IT": "Vostra {0} squadra",
"pt_PT": "Ihr {0} Team",
"fr_FR": "Votre équipe {0}",
"en_US": "Your {0} team",
"de_AT": "Ihr {0} Team",
"fr_CH": "Votre équipe {0}",
"en_GB": "Your {0} team",
"nl_BE": "Ihr {0} Team"
},
"fields": [{
"name": "KeyAccountManager",
"profileType": "CORPORATE",
"editable": true,
"defaultLabel": "Key Account Manager",
"labels": {},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
},
{
"name": "Teamzuordnung",
"profileType": "CORPORATE",
"editable": true,
"defaultLabel": "Teamzuordnung",
"labels": {},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
}
]
},
{
"groupType": "INTEGRATED",
"defaultLabel": "General",
"labels": {
"sv_SE": "Generell",
"es_ES": "General",
"fr_BE": "Général",
"nl_NL": "Allgemein",
"hu_HU": "Általános",
"de_CH": "Allgemein",
"it_CH": "Generale",
"de_DE": "Allgemein",
"kl_GL": "Tamanut atuuttoq",
"cs_CZ": "Obecné",
"da_DK": "Generelt",
"pl_PL": "Ogólne",
"sk_SK": "Všeobecne",
"it_IT": "Generale",
"pt_PT": "Allgemein",
"fr_FR": "Général",
"en_US": "General",
"de_AT": "Allgemein",
"fr_CH": "Général",
"en_GB": "General",
"nl_BE": "Allgemein"
},
"fields": [{
"name": "EmergencyNo",
"profileType": "CORPORATE",
"editable": true,
"defaultLabel": "Emergency no.",
"labels": {
"de_CH": "Notfallnummer",
"en_GB": "Emergency no."
},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
}]
},
{
"groupType": "INTEGRATED",
"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": [{
"name": "HotelInformation",
"profileType": "",
"editable": true,
"defaultLabel": "Hotel Information",
"labels": {},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
},
{
"name": "AllgemeineInformation",
"profileType": "TRAVELLER",
"editable": true,
"defaultLabel": "Allgemeine Information",
"labels": {},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
},
{
"name": "CarInformation",
"profileType": "",
"editable": true,
"defaultLabel": "Car information",
"labels": {},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
},
{
"name": "FareInformation",
"profileType": "CORPORATE",
"editable": true,
"defaultLabel": "Fare information",
"labels": {},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
},
{
"name": "AirlineInformation",
"profileType": "CORPORATE",
"editable": true,
"defaultLabel": "Airline information",
"labels": {},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
},
{
"name": "RailInformation",
"profileType": "",
"editable": true,
"defaultLabel": "Rail Information",
"labels": {},
"fieldType": "INPUT",
"elective": "OPTIONAL",
"validation": {
"@type": "none"
}
}
]
},
{
"groupType": "CUSTOM",
"defaultLabel": "Referenzfelder",
"labels": {
"de_CH": "Referenzfelder",
"de_AT": "Referenzfelder",
"fr_CH": "Reference details",
"en_GB": "Reference details"
},
"fields": [{
"name": "Projektnummer",
"profileType": "",
"editable": true,
"defaultLabel": "Projektnummer",
"labels": {},
"fieldType": "INPUT",
"elective": "COMPANY_SPECIFIC",
"validation": {
"@type": "none"
}
},
{
"name": "Kostenstelle",
"profileType": "",
"editable": true,
"defaultLabel": "Kostenstelle",
"labels": {},
"fieldType": "INPUT",
"elective": "COMPANY_SPECIFIC",
"validation": {
"@type": "none"
}
},
{
"name": "SAPNummer",
"profileType": "",
"editable": true,
"defaultLabel": "SAP Nummer",
"labels": {},
"fieldType": "INPUT",
"elective": "COMPANY_SPECIFIC",
"validation": {
"@type": "none"
}
},
{
"name": "Personalnummer1",
"profileType": "",
"editable": true,
"defaultLabel": "Personalnummer",
"labels": {},
"fieldType": "INPUT",
"elective": "COMPANY_SPECIFIC",
"validation": {
"@type": "none"
}
},
{
"name": "DSNummer",
"profileType": "",
"editable": true,
"defaultLabel": "DS Nummer",
"labels": {},
"fieldType": "INPUT",
"elective": "COMPANY_SPECIFIC",
"validation": {
"@type": "none"
}
}
]
}
]
} |
Get generic setup for company
| Scopes | api.profilesondemand.read |
|---|---|
| Endpoints | api/v1/configuration/setup/company/{uuid} |
| Request method | GET |
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 |
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \
"https://hurricane.umbrellanet.ch/uf-test/api/v1/configuration/setup/company/76445ed3-cbd4-45f5-96fc-f8f60745d529?merged=false" |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"groups": [{
"groupType": "CUSTOM",
"defaultLabel": "Referenzfelder",
"labels": {
"de_CH": "Referenzfelder",
"de_AT": "Referenzfelder",
"fr_CH": "Reference details",
"en_GB": "Reference details"
},
"fields": [{
"name": "Test-Abteilung",
"profileType": "",
"editable": true,
"defaultLabel": "Test-bteilung",
"labels": {},
"fieldType": "INPUT",
"elective": "COMPANY_SPECIFIC",
"validation": {
"@type": "none"
}
}]
}]
} |
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 |
...