This API is used to query the CESSDA Vocabulary Service [ https://vocabularies.cessda.eu/ ]. You can read the documentation and try it out on the Vocabulary Service Search API page by selecting it from the top menu.
The main use case is:
As a CESSDA Service Provider, I want my study level metadata record creation tool to use relevant Controlled Vocabularies so that the metadata I get is more uniform and consistent with DDI Alliance and CESSDA metadata recommendations.
Step 1: Adapt the relevant fields of the study level metadata record creation form to read the associated vocabulary via the search API.
Step 2: The metadata creator selects values from the list to fill certain fields, rather than typing in free text. Note that a free text field might be still be useful to have in addition for more comprehensive explanation.
Original report on BitBucket by Taina Jääskeläinen.
The text referring to CESSDA Vocabulary Service in the Rest API page
ttps://api.tech.cessda.eu/
could be amended to (amended text in italics):
CESSDA Vocabulary Service Search API
This API is used to query the CESSDA Vocabulary Service [ https://vocabularies.cessda.eu/ ]. You can read the documentation and try it out on the Vocabulary Service Search API page by selecting it from the top menu.
The main use case is:
As a CESSDA Service Provider, I want my study level metadata record creation tool to use relevant Controlled Vocabularies so that the metadata I get is more uniform and consistent with DDI Alliance and CESSDA metadata recommendations.
Step 1: Adapt the relevant fields of the study level metadata record creation form to read the associated vocabulary via the search API.
Step 2: The metadata creator selects values from the list to fill certain fields, rather than typing in free text. Note that a free text field might be still be useful to have in addition for more comprehensive explanation.