Get all communication forms in the system.
Get All Communication Forms
Retrieves the full list of communication forms available in the system.
This is a standard list, but it can be configured to the user's preferences; configuration is performed in the Bloxs application and cannot be done through the API. communicationFormName refers to this list on the Person endpoints, where it is a required field, and decides the standard method of addressing the person in communication coming from the Bloxs application.
A developer calls this endpoint to retrieve the full list of valid options before adding a Person, so that a valid value can be supplied for communicationFormName.
Request Fields
This endpoint takes no request parameters.
Field | Type | Required | Description |
|---|---|---|---|
(none) | This endpoint has no request fields. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
name | string, nullable | Optional | The selectable value stored as communicationFormName on a Person, for example "Man", "Vrouw", or "Onbekend". |
title | string, nullable | Optional | The salutation text generated in correspondence for this communication form, for example "Meneer" or "Meneer / mevrouw". |
OK