Edge API - OAI-PMH version v1
https://github.com/folio-org/edge-oai-pmh
Edge API - OAI-PMH
Edge API to interface with FOLIO for 3rd party harvesters to harvest metadta via OAI-PMH
OAI-PMH
Run OAI-PMH request
Run OAI-PMH request
get /oai
Run OAI-PMH request
Query Parameters
- verb: required(string)
One of the defined OAI-PMH verbs
- identifier: (string)
The unique identifier of the item in the repository from which the record must be disseminated
- metadataPrefix: (string)
The metadataPrefix of the format that should be included in the metadata part of the returned record
- from: (datetime)
UTC datetime value, which specifies a lower bound for datestamp-based selective harvesting
Example:
2018-11-25T16:17:18Z
- until: (datetime)
UTC datetime value, which specifies a upper bound for datestamp-based selective harvesting
Example:
2018-11-28T14:15:16Z
- set: (string)
SetSpec value, which specifies set criteria for selective harvesting
- resumptionToken: (string)
The flow control token returned by a ListIdentifiers request that issued an incomplete list
- apikey: required(string)
API Key
HTTP status code 200
Success
Body
Media type: text/xml
Type: any
HTTP status code 400
Bad Request
Body
Media type: text/xml
Type: any
HTTP status code 401
Access Denied
Body
Media type: text/xml
Type: any
HTTP status code 404
Not found
Body
Media type: text/xml
Type: any
HTTP status code 406
Not Acceptable
Body
Media type: text/xml
Type: any
HTTP status code 422
Unprocessable Entity
Body
Media type: text/xml
Type: any
HTTP status code 500
Internal Server Error
Body
Media type: text/plain
Type: any
HTTP status code 501
Not Implemented
Body
Media type: text/xml
Type: any
post /oai
Run OAI-PMH request
Query Parameters
- verb: required(string)
One of the defined OAI-PMH verbs
- identifier: (string)
The unique identifier of the item in the repository from which the record must be disseminated
- metadataPrefix: (string)
The metadataPrefix of the format that should be included in the metadata part of the returned record
- from: (datetime)
UTC datetime value, which specifies a lower bound for datestamp-based selective harvesting
Example:
2018-11-25T16:17:18Z
- until: (datetime)
UTC datetime value, which specifies a upper bound for datestamp-based selective harvesting
Example:
2018-11-28T14:15:16Z
- set: (string)
SetSpec value, which specifies set criteria for selective harvesting
- resumptionToken: (string)
The flow control token returned by a ListIdentifiers request that issued an incomplete list
- apikey: required(string)
API Key
HTTP status code 200
Success
Body
Media type: text/xml
Type: any
HTTP status code 400
Bad Request
Body
Media type: text/xml
Type: any
HTTP status code 401
Access Denied
Body
Media type: text/xml
Type: any
HTTP status code 404
Not found
Body
Media type: text/xml
Type: any
HTTP status code 406
Not Acceptable
Body
Media type: text/xml
Type: any
HTTP status code 422
Unprocessable Entity
Body
Media type: text/xml
Type: any
HTTP status code 500
Internal Server Error
Body
Media type: text/plain
Type: any
HTTP status code 501
Not Implemented
Body
Media type: text/xml
Type: any
Run OAI-PMH request
Run OAI-PMH request
get /oai/{apiKeyPath}
Run OAI-PMH request
URI Parameters
- apiKeyPath: required(string)
Query Parameters
- verb: required(string)
One of the defined OAI-PMH verbs
- identifier: (string)
The unique identifier of the item in the repository from which the record must be disseminated
- metadataPrefix: (string)
The metadataPrefix of the format that should be included in the metadata part of the returned record
- from: (datetime)
UTC datetime value, which specifies a lower bound for datestamp-based selective harvesting
Example:
2018-11-25T16:17:18Z
- until: (datetime)
UTC datetime value, which specifies a upper bound for datestamp-based selective harvesting
Example:
2018-11-28T14:15:16Z
- set: (string)
SetSpec value, which specifies set criteria for selective harvesting
- resumptionToken: (string)
The flow control token returned by a ListIdentifiers request that issued an incomplete list
HTTP status code 200
Success
Body
Media type: text/xml
Type: any
HTTP status code 400
Bad Request
Body
Media type: text/xml
Type: any
HTTP status code 401
Access Denied
Body
Media type: text/xml
Type: any
HTTP status code 404
Not found
Body
Media type: text/xml
Type: any
HTTP status code 406
Not Acceptable
Body
Media type: text/xml
Type: any
HTTP status code 422
Unprocessable Entity
Body
Media type: text/xml
Type: any
HTTP status code 500
Internal Server Error
Body
Media type: text/plain
Type: any
HTTP status code 501
Not Implemented
Body
Media type: text/xml
Type: any
post /oai/{apiKeyPath}
Run OAI-PMH request
URI Parameters
- apiKeyPath: required(string)
Query Parameters
- verb: required(string)
One of the defined OAI-PMH verbs
- identifier: (string)
The unique identifier of the item in the repository from which the record must be disseminated
- metadataPrefix: (string)
The metadataPrefix of the format that should be included in the metadata part of the returned record
- from: (datetime)
UTC datetime value, which specifies a lower bound for datestamp-based selective harvesting
Example:
2018-11-25T16:17:18Z
- until: (datetime)
UTC datetime value, which specifies a upper bound for datestamp-based selective harvesting
Example:
2018-11-28T14:15:16Z
- set: (string)
SetSpec value, which specifies set criteria for selective harvesting
- resumptionToken: (string)
The flow control token returned by a ListIdentifiers request that issued an incomplete list
HTTP status code 200
Success
Body
Media type: text/xml
Type: any
HTTP status code 400
Bad Request
Body
Media type: text/xml
Type: any
HTTP status code 401
Access Denied
Body
Media type: text/xml
Type: any
HTTP status code 404
Not found
Body
Media type: text/xml
Type: any
HTTP status code 406
Not Acceptable
Body
Media type: text/xml
Type: any
HTTP status code 422
Unprocessable Entity
Body
Media type: text/xml
Type: any
HTTP status code 500
Internal Server Error
Body
Media type: text/plain
Type: any
HTTP status code 501
Not Implemented
Body
Media type: text/xml
Type: any
Health Check
Health Check