Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
titleExample Response
collapsetrue
{
	"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": "list",
			"@type": "none"
					}
				}
			]
		}            "items": [
			              {
			                "optValue": "2",
			                "optLabel": "Zwei"
			              },
			              {
			                "optValue": "3",
			                "optLabel": "Drei"
			              },
			              {
			                "optValue": "1",
            			    "optLabel": "Eins"
			              }
			            ]
					}
				}
			]
		},
		{
			"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": "regex",
			"@type            "expression": "none[0-9]{0,10}"
					}
				},
				{
					"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 methodGET

Fetch the generic setup of a company tailored to the access level of the calling user / application

Parameters
NameDescriptionValidation
<uuid>The UUID of the companyRequired parameter
mergedDefines 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
languagebash
titleExample request
curl -v -H "Authorization: Bearer <token>" \
    "https://hurricane.umbrellanet.ch/uf-test/api/v1/configuration/setup/company/76445ed3-cbd4-45f5-96fc-f8f60745d529?merged=false"

...