OAI-PMH API version v3.1
https://github.com/folio-org/mod-oai-pmh
Set API
API for retirieving filtering condition values
Filtering conditions
Retrieve values for next filtering condition types: location, illpolicy, material-type, resource-type, instance-formats.
get
get /oai-pmh/filtering-conditions
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filtering condition DTO Schema",
"type": "object",
"additionalProperties": false,
"properties": {
"setsFilteringConditions": {
"description": "list of filtering condition values",
"type": "array",
"id": "filteringConditionValues",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filtering condition DTO Schema",
"additionalProperties": false,
"properties": {
"name": {
"description": "Filtering condition name",
"type": "string"
},
"values": {
"description": "Filtering condition value",
"type": "array"
}
}
}
}
}
}Example:
{
"filteringConditions": [
{
"name": "location",
"values": [
"location 1",
"location 2",
"location 3"
]
},
{
"name": "resourceType",
"values": [
"resourceType 1",
"resourceType 2",
"resourceType 3"
]
},
{
"name": "format",
"values": [
"format 1",
"format 2",
"format 3"
]
},
{
"name": "illPolicy",
"values": [
"illPolicy 1",
"illPolicy 2",
"illPolicy 3"
]
},
{
"name": "materialType",
"values": [
"materialType 1",
"materialType 2",
"materialType 3"
]
}
]
}
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
Unable to get filtering condition values. UnauthorizedHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator