Label of Controlled Vocabularies

How to access the labels of controlled vocabularies in OERSI via API.

Categories:

less than a minute

Note: the endpoint https://oersi.org/resources/api-internal/label/ is still available, but deprecated and will be removed in the future. Please use https://oersi.org/resources/api/label/ instead.

LABEL API

Listing labels of controlled vocabularies which are used in the metadata schema.

API description

GET /resources/api/label/{language} (gets the labels of controlled vocabularies used in the metadata schema)

Parameters

name type data type description

language (path) required string Language-code of the labels (ISO-639-1)

field (query) optional string Name of the field to retrieve the labels for. Labels of all fields if this parameter is omitted.

name	type	data type	description
`language`	(path) required	string	Language-code of the labels (ISO-639-1)
`field`	(query) optional	string	Name of the field to retrieve the labels for. Labels of all fields if this parameter is omitted.

Responses

http code content-type response

200 application/json JSON-response containing all the ID -> LABEL Mappings

http code	content-type	response
`200`	`application/json`	JSON-response containing all the ID -> LABEL Mappings

Example cURL

 curl -X GET -H "Content-Type: application/json" https://oersi.org/resources/api/label/de?field=learningResourceType