https://github.com/folio-org/edge-oai-pmh
Edge API to interface with FOLIO for 3rd party harvesters to harvest metadta via OAI-PMH
Run OAI-PMH request
GET /oai
One of the defined OAI-PMH verbs
The unique identifier of the item in the repository from which the record must be disseminated
The metadataPrefix of the format that should be included in the metadata part of the returned record
UTC datetime value, which specifies a lower bound for datestamp-based selective harvesting
Example:
2018-11-25T16:17:18Z
UTC datetime value, which specifies a upper bound for datestamp-based selective harvesting
Example:
2018-11-28T14:15:16Z
SetSpec value, which specifies set criteria for selective harvesting
The flow control token returned by a ListIdentifiers request that issued an incomplete list
API Key
Success
Media type: text/xml
Type: any
Bad Request
Media type: text/xml
Type: any
Access Denied
Media type: text/xml
Type: any
Not found
Media type: text/xml
Type: any
Not Acceptable
Media type: text/xml
Type: any
Unprocessable Entity
Media type: text/xml
Type: any
Internal Server Error
Media type: text/plain
Type: any
Not Implemented
Media type: text/xml
Type: any
Run OAI-PMH request
POST /oai
One of the defined OAI-PMH verbs
The unique identifier of the item in the repository from which the record must be disseminated
The metadataPrefix of the format that should be included in the metadata part of the returned record
UTC datetime value, which specifies a lower bound for datestamp-based selective harvesting
Example:
2018-11-25T16:17:18Z
UTC datetime value, which specifies a upper bound for datestamp-based selective harvesting
Example:
2018-11-28T14:15:16Z
SetSpec value, which specifies set criteria for selective harvesting
The flow control token returned by a ListIdentifiers request that issued an incomplete list
API Key
Success
Media type: text/xml
Type: any
Bad Request
Media type: text/xml
Type: any
Access Denied
Media type: text/xml
Type: any
Not found
Media type: text/xml
Type: any
Not Acceptable
Media type: text/xml
Type: any
Unprocessable Entity
Media type: text/xml
Type: any
Internal Server Error
Media type: text/plain
Type: any
Not Implemented
Media type: text/xml
Type: any
Run OAI-PMH request
GET /oai/{apiKeyPath}
One of the defined OAI-PMH verbs
The unique identifier of the item in the repository from which the record must be disseminated
The metadataPrefix of the format that should be included in the metadata part of the returned record
UTC datetime value, which specifies a lower bound for datestamp-based selective harvesting
Example:
2018-11-25T16:17:18Z
UTC datetime value, which specifies a upper bound for datestamp-based selective harvesting
Example:
2018-11-28T14:15:16Z
SetSpec value, which specifies set criteria for selective harvesting
The flow control token returned by a ListIdentifiers request that issued an incomplete list
Success
Media type: text/xml
Type: any
Bad Request
Media type: text/xml
Type: any
Access Denied
Media type: text/xml
Type: any
Not found
Media type: text/xml
Type: any
Not Acceptable
Media type: text/xml
Type: any
Unprocessable Entity
Media type: text/xml
Type: any
Internal Server Error
Media type: text/plain
Type: any
Not Implemented
Media type: text/xml
Type: any
Run OAI-PMH request
POST /oai/{apiKeyPath}
One of the defined OAI-PMH verbs
The unique identifier of the item in the repository from which the record must be disseminated
The metadataPrefix of the format that should be included in the metadata part of the returned record
UTC datetime value, which specifies a lower bound for datestamp-based selective harvesting
Example:
2018-11-25T16:17:18Z
UTC datetime value, which specifies a upper bound for datestamp-based selective harvesting
Example:
2018-11-28T14:15:16Z
SetSpec value, which specifies set criteria for selective harvesting
The flow control token returned by a ListIdentifiers request that issued an incomplete list
Success
Media type: text/xml
Type: any
Bad Request
Media type: text/xml
Type: any
Access Denied
Media type: text/xml
Type: any
Not found
Media type: text/xml
Type: any
Not Acceptable
Media type: text/xml
Type: any
Unprocessable Entity
Media type: text/xml
Type: any
Internal Server Error
Media type: text/plain
Type: any
Not Implemented
Media type: text/xml
Type: any
Health Check
GET /admin/health