Edge API - OAI-PMH (v1)

https://github.com/folio-org/edge-oai-pmh

Table of contents

Edge API - OAI-PMH

Edge API to interface with FOLIO for 3rd party harvesters to harvest metadta via OAI-PMH

OAI-PMH

GET /oai

Run OAI-PMH request

GET /oai
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

Response 200

Success

Body

Media type: text/xml

Response 400

Bad Request

Body

Media type: text/xml

Response 401

Access Denied

Body

Media type: text/xml

Response 404

Not found

Body

Media type: text/xml

Response 422

Unprocessable Entity

Body

Media type: text/xml

Response 500

Internal Server Error

Body

Media type: text/plain

Type: any

Response 501

Not Implemented

Body

Media type: text/xml

POST /oai

Run OAI-PMH request

POST /oai
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

Response 200

Success

Body

Media type: text/xml

Response 400

Bad Request

Body

Media type: text/xml

Response 401

Access Denied

Body

Media type: text/xml

Response 404

Not found

Body

Media type: text/xml

Response 422

Unprocessable Entity

Body

Media type: text/xml

Response 500

Internal Server Error

Body

Media type: text/plain

Type: any

Response 501

Not Implemented

Body

Media type: text/xml

GET /oai/{apiKeyPath}

Run OAI-PMH request

GET /oai/{apiKeyPath}
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

Response 200

Success

Body

Media type: text/xml

Response 400

Bad Request

Body

Media type: text/xml

Response 401

Access Denied

Body

Media type: text/xml

Response 404

Not found

Body

Media type: text/xml

Response 422

Unprocessable Entity

Body

Media type: text/xml

Response 500

Internal Server Error

Body

Media type: text/plain

Type: any

Response 501

Not Implemented

Body

Media type: text/xml

POST /oai/{apiKeyPath}

Run OAI-PMH request

POST /oai/{apiKeyPath}
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

Response 200

Success

Body

Media type: text/xml

Response 400

Bad Request

Body

Media type: text/xml

Response 401

Access Denied

Body

Media type: text/xml

Response 404

Not found

Body

Media type: text/xml

Response 422

Unprocessable Entity

Body

Media type: text/xml

Response 500

Internal Server Error

Body

Media type: text/plain

Type: any

Response 501

Not Implemented

Body

Media type: text/xml

Health Check

GET /admin/health

Health Check

GET /admin/health

Response 200

Success

Body

Media type: text/plain

Type: any