...
Anchor GetCompanyProfile GetCompanyProfile
Get company profile
| GetCompanyProfile | |
| GetCompanyProfile |
| Scope | api.profilesondemand.read |
|---|---|
| Endpoint | api/v1/profiles/company/<uuid> |
| Request method | GET |
Retrieves the details of a single company profile.
Parameters
| Name | Description | Validation |
|---|---|---|
| <uuid> | The UUID of the profile to retrieve | Required parameter |
| sections | Areas of the profile to be returned. May be used to reduce the amount of data transferred, if only specific information is required All sections will be dumped if omitted. Please identify the relevant sections for your application during development and use a restricted information subset before moving to production. | Optional |
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -v -H "Authorization: Bearer <token>" \
https://hurricane.umbrellanet.ch/uf-test/api/v1/profiles/company/b9321d7e-9d72-4e80-ac49-d3aa38169175?sections=CONTACT_DATA,MEMBERSHIPS |
...
The following sections are currently available in accordance with our Swagger schema definition:
| Name | Contents |
|---|---|
| AGNCY_INFO | Agency information:
|
| CONTACT_DATA | Company contact data:
|
| MEMBERSHIPS | Corporate alliance Memberships
|
| GENERIC_VALUES | Values (where filled) from the generic setup, output as key-value pairs where the key is the fieldname and the value is the value entered on the profile. |
Create new company profile
| Scope | api.profilesondemand.write |
|---|---|
| Endpoint | api/v1/profiles/company |
| Request method | POST |
Create a new company profile
...
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>" \
--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.
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