...
Faces will apply default validation logic as seen on our Web UI and CSV interfaces and will report validation errors to the caller without saving the profile.
When adding a passport which should at the same time be added on a visa as linkedPassport, the following format has to be used to reference the passport (as no UUID is yet available): newpp-<2-letter-country code>-<passport number>
Example: newpp-CH-X12345678
Update existing company profile
| Scope | api.profilesondemand.write |
|---|---|
| Endpoint | api/v1/profiles/company/<uuid> |
| Request method | PATCH |
Updates (part of) the details of a single company profile.
Parameters
| Name | Description | Validation |
|---|---|---|
| <uuid> | The UUID of the profile to update | Required parameter |
| Code Block |
|---|
curl -v -X PATCH \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data '{
"externalNr": "0815",
"name": "ACME Incorporated",
"shortname": "ACME-INC",
"data": {
"memberships": {
"airline": [{
"alliance": "LH",
"memberNumber": "DEMODEMO123",
"type": "SPECIAL_KEYWORD"
}]
}
}
}' https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/company/b9321d7e-9d72-4e80-ac49-d3a |
Implementation notes
Depending on the authorization level of the caller, it may not be possible to edit certain properties. Changes to unmodifiable properties will be silently ignored if sent.
Callers should include only the properties they wish to edit in the PATCH request. Due to underlying synchronization logic to third party systems, it is required to perform all profile modifications within one single PATCH call (I.e. do not first edit the shortname, then add a membership code as two separate API calls).
The following logic is applied when editing collections, such as memberships to allow for modification of single elements within the collection without having separate API calls for that purpose:
If an “uuid” is supplied, the corresponding collection element is being modified
If there is no matching element with the given UUID, the update is ignored
In order to remove a collection item, it’s UUID is supplied, along with a property “_operation”, which is set to “remove”
In order to remove genericValues from a profile, please include the fieldname but set the field content to empty or null.
When adding a new passport which should at the same time be added on a visa as linkedPassport, the following format has to be used to reference the passport (as no UUID is yet available): newpp-<2-letter-country code>-<passport number>
Example: newpp-CH-X12345678
Delete company profile
| Scope | api.profilesondemand.write |
|---|---|
| Endpoint | api/v1/profiles/company/<uuid> |
| Request method | DELETE |
Delete a single company profile (along with all associated traveler profiles) from Faces as well as all downline systems.
Parameters
| Name | Description | Validation |
|---|---|---|
| <uuid> | The UUID of the profile to delete | Required parameter |
| Code Block |
|---|
curl -v -X DELETE \
-H "Authorization: Bearer <token>" \
https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/company/b9321d7e-9d72-4e80-ac49-d3aa38169175 |
Example response
HTTP 204 “No Content” with empty body
Search traveler profile
| Scope | api.profilesondemand.read |
|---|---|
| Endpoint | api/v1/profiles/travellers |
| Request method | GET |
Parameters
| Name | Description | Validation |
|---|---|---|
| q | Freetext query for finding matching profiles | Required parameter |
| page | Current page within the result set, starts at 0 | Optional, number >= 0 |
| pageSize | Maximum number of results per page. Default 10 | Optional, number > 0 and <= 100 |
| c | Narrow down the search for travelers attached to a specific company profile | Optional, company UUID |
| scope | Search scope | Optional, may be one of:
|
| p | Search scope parameter | Required if scope=GENERIC_FIELD: Name of the generic field to search in Optional for scope=RECORD_LOCATOR: System type or Label (e.g. “CSX”, “GALILEO_WS”, “My HR-System”) Optional for scope=PAPER: Type of paper to search for, PASSPORT, ID_CARD or VISA Prohibited otherwise |
| includeDetails | Specify whether the search response should include detailed profile data | Boolean value: true or false Optional, default: false |
| detailSections | Specify additional profile areas to be returned if includeDetails is set to true. Only explicitly specified sections will be included. | Only the following sections are currently supported:
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \
"https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/travellers?q=bob&page=0&pageSize=10" |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"moreResults": false,
"results": [{
"uuid": "065fe9e0-47b7-4d12-b3de-d3aa38169175",
"fullName": "Herr Bob Builder"
}]
} |
| Anchor | ||||
|---|---|---|---|---|
|
| Scope | api.profilesondemand.read |
|---|---|
| Endpoint | api/v1/profiles/traveller/<uuid> |
| Request method | GET |
...
Faces will apply default validation logic as seen on our Web UI and CSV interfaces and will report validation errors to the caller without saving the profile.
When adding a passport which should at the same time be added on a visa as linkedPassport, the following format has to be used to reference the passport (as no UUID is yet available): newpp-<2-letter-country code>-<passport number>
Example: newpp-CH-X12345678
Update existing traveler profile
...
In order to remove genericValues from a profile, please include the fieldname but set the field content to empty or null.
When adding a passport which should at the same time be added on a visa as linkedPassport, the following format has to be used to reference the passport (as no UUID is yet available): newpp-<2-letter-country code>-<passport number>
Example: newpp-CH-X12345678
Delete traveler profile
| Scope | api.profilesondemand.write |
|---|---|
| Endpoint | api/v1/profiles/traveller/<uuid> |
| Request method | DELETE |
...