Reminder: Profile Sections handling
The API calls for retrieving a company and/or traveller profile utilize a concept of information-sections, which allows for clients to fetch only the data specifically needed for processing instead of the complete profile.
So far, these API calls have defaulted to returning all available data if the sections parameter has been omitted.
As more and more sections are being made available, we will change the default behaviour.
Starting on May 31st, 2022 we will only return sections that have been explicitly requested in order to cut down on the amount of unnecessary data being exchanged between systems.
Affected API calls
Only the following API calls are affected by this change:
- GET /api/v1/profiles/company/{uuid}
- GET /api/v1/profiles/traveller/{uuid}
Generic (Field) Values handling
We are going to change the section handling custom fields (generic values).
So far, custom field data was available (where filled) in the section 'GENERIC_VALUES' as a map of key-value pairs with the key being the field name (applicable to company and traveller profiles).
Starting from November 1st, 2022 we will only support the new section GENERIC_FIELD_VALUES for getting custom field data (where filled).
This new section includes besides of the field name and the value also the UUID number of the custom field.
Updates to a custom field can be done using the field name or uuid, where uuid however has priority over the field name.
We are going to remove the old 'GENERIC_VALUES' section on October 31st, 2022.
For the time being, either of the options (GENERIC_VALUES or GENERIC_FIELD_VALUES) can be used. However, we kindly ask you to perform the necessary changes until end of October latest.