Versions Compared

Key

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

...

Code Block
languagejs
titleExample Response
{
	"uuid": "ceb545fd-5000-4f44-93dd-47a272f6f25a",
	"username": "demo.user",
	"firstname": "Demo",
	"name": "Traveller",
	"email": "demo@umbrella.ch",
	"data": {
		"creditCardInfo": {
			"creditCards": [{
				"uuid": "bcf0cfc2-5262-4996-98fb-f9a2ca8dc7a4",
				"type": "VI",
				"maskedNumber": "4444XXXXXXXX1111",
				"expiration": "12/25",
				"remark": "",
				"publishAsFop": true
			}, {
				"uuid": "6e6259b9-4fa9-41c7-8a7b-f5d68df8f38b",
				"type": "VI",
				"maskedNumber": "4242XXXXXXXX4242",
				"expiration": "12/25",
				"remark": "",
				"publishAsFop": true
			}],
			"webCard": {
				"@type": "own-card",
				"uuid": "6e6259b9-4fa9-41c7-8a7b-f5d68df8f38b",
				"maskedNumber": "4242XXXXXXXX4242"
			},
			"hotelGuarantee": {
				"@type": "own-card",
				"uuid": "bcf0cfc2-5262-4996-98fb-f9a2ca8dc7a4",
				"maskedNumber": "4444XXXXXXXX1111"
			},
			"carGuarantee": {
				"@type": "company-card",
				"uuid": "0d67e63f-a8a6-4a73-b826-d815a04aaedd",
				"maskedNumber": "5200XXXXXXXX0007"
			}
		}
	}
}

System reference data API

This API is complimentary to the Profiles API and allows to query Umbrella Faces for reference data, such as lists of known rentalcar providers.

Note

This API is currently under development and not yet generally available

Get frequent flyer options

Scopes

(none needed)

Endpoints

api/v1/reference-data/air-providers

Request methodGET

Fetch a list of available frequent flyer options

Parameters
NameDescriptionValidation
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:

  • TRAVELLER
  • CORPORATE

Will return all frequent flyer options (unfiltered) if omitted

Code Block
languagebash
titleExample request
curl -v -H "Authorization: Bearer <token>" \
    "https://hurricane.umbrellanet.ch/uf-test/api/v1/reference-data/air-providers?profileType=TRAVELLER"

Get rental car providers

Scopes

(none needed)

Endpoints

api/v1/reference-data/car-providers

Request methodGET

Fetch a list of available rental car providers

Code Block
languagebash
titleExample request
curl -v -H "Authorization: Bearer <token>" \
    "https://hurricane.umbrellanet.ch/uf-test/api/v1/reference-data/car-providers"

Get rail card types

Scopes

(none needed)

Endpoints

api/v1/reference-data/rail-card-types

Request methodGET

Fetch a list of known rail card types

Parameters
NameDescriptionValidation
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

Code Block
languagebash
titleExample request
curl -v -H "Authorization: Bearer <token>" \
    "https://hurricane.umbrellanet.ch/uf-test/api/v1/reference-data/rail-card-types"