The Boards field in the main profile is stored in the system as a field collection. Creating and Updating the Boards fields is the same call, detailed in our profile creation example, as updating the Financial Relationship fields in the baseline disclosure, with a few small adjustments.
A separate call is required for each board to the field_collection_item endpoint. Additionally, each board itself stores its individual fields in a multi-value array.
Field names and values may change depending on individual client requirements. You can verify your specific values with your Product Specialist. |
The individual Board fields in the field collection are:
field_accme_board_name
: A select field expecting the machine name value of the Board.
field_accme_board_id
: A free text field.
The fields required for the collection’s association to the correct profile are:
field_name
: The profile field machine name. This may be different for each customer. The default value is field_accme_ids
. You can verify this value with your project manager.
host_entity
: A multi dimensional array containing the id and resource type of the entity. For all calls, the resource
is profile2
, while the id
will change per learner account.
A user’s Profile ID is separate from their User ID. The Profile ID may be acquired by querying the user endpoint. |
The examples below update a learner on the production site with a profile ID of 127, sending Board information for “American Board of Internal Medicine (ABIM)“ with ID number “PA12345“ and the “American Board of Physical Medicine and Rehabilitation (ABPM&R)” board, with ID number “DE09876“.
curl -X POST -H "Content-Type: application/json" -u 'USER:PASSWORD' https://your-domain.com/field_collection_item.json -d \ '{"host_entity":{"id":"127","resource":"profile2"},"field_name":"field_accme_ids","field_accme_board_id":"PA12345","field_accme_board_name":"abim"}' |
curl -X POST -H "Content-Type: application/json" -u 'USER:PASSWORD' https://your-domain.com/field_collection_item.json -d \ '{"host_entity":{"id":"127","resource":"profile2"},"field_name":"field_accme_ids","field_accme_board_id":"DE09876","field_accme_board_name":"abpmr"}' |
A successful return provides the id information of the newly created field_collection_item entity.
{"uri":"https:\/\/your-domain.com\/field_collection_item\/289","id":"289","resource":"field_collection_item","uuid":"8d8a6aeb-19bb-4e85-a311-ee075f617f45"} |