- 13 Jul 2024
- 1 Minute to read
- Print
- DarkLight
Get all communication forms
- Updated on 13 Jul 2024
- 1 Minute to read
- Print
- DarkLight
Get all communication forms in the system.
Description
Returns the list of all available communication forms. This is a standard list, however it can be configured to the preferences of the user. Configuration is performed in the Bloxs application and cannot be conducted through the API. CommunicationForms refers to the 'communicationFormName' field in the persons endpoints and decides on the standard method of addressing the person in communication coming from the Bloxs application. In order to enter a valid option in 'communicationFormName', the endpoint 'Get CommunicationForms' can be used to retrieve the full list of available options.
Example Use Case
The Bloxs user wants to add a person. One of the compulsory fields is the communicationFormName. However, the user does not know which options are available. By making a call to the Get CommunicationForms endpoint a full list will be returned of available options. Subsequently this can be used as input for adding a person.
Please enter a valid token
Success