mod-kb-ebsco-java (v1)

https://github.com/folio-org/mod-kb-ebsco-java

Table of contents

mod-kb-ebsco-java

Implements the eholdings interface using EBSCO KB as backend.

Status

Gives status of currently set KB configuration.

GET /eholdings/status

Gives status of currently set KB configuration.

GET /eholdings/status

Response 200

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Status Response Schema",
  "description": "Status Response Schema using JSON API",
  "type": "object",
  "javaType": "org.folio.rest.jaxrs.model.ConfigurationStatus",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "javaType": "org.folio.rest.jaxrs.model.StatusData",
      "description": "Status Data",
      "$ref": "statusData.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "../jsonapi.json"
    }
  }
}

Example:

{
  "data": {
    "id": "status",
    "type": "statuses",
    "attributes": {
      "isConfigurationValid": true
    }
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Cache

DELETE /eholdings/cache

Invalidate configuration cache for tenant

DELETE /eholdings/cache

Response 204

No Content

Run load holdings job

POST /loadHoldings

Run load holdings job.

POST /loadHoldings
Headers
  • Content-Type: required (string)

    Example:

    application/json

Response 204

No Content

Response 409

Process of loading holdings is already running

Body

Media type: text/plain

Type: any

Example:

Process of loading holdings is already running

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /loadHoldings/status

Get current status of load holdings job.

GET /loadHoldings/status
Headers
  • Content-Type: required (string)

    Example:

    application/json

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Holdings Loading Status Schema",
  "description": "Holdings Loading Status Schema",
  "javaType": "org.folio.rest.jaxrs.model.HoldingsLoadingStatus",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "type": "object",
      "description": "Status data",
      "$ref": "loadHoldingsStatusData.json"
    },
    "jsonapi": {
      "type": "object",
      "description": "version of json api",
      "$ref": "../jsonapi.json"
    }
  },
  "required": [
    "data",
    "jsonapi"
  ]
}

Example:

{
  "data": {
    "type": "status",
    "attributes": {
      "started": "1999-12-31 14:59:59",
      "finished": "1999-12-31 16:30:47",
      "totalCount": 1234,
      "status": {
        "name": "Completed"
      }
    }
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Run load holdings for provided credentials id

POST /eholdings/loading/kb-credentials/{id}

Run load holdings job by credentials id.

POST /eholdings/loading/kb-credentials/{id}
URI Parameters
  • id: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)
Headers
  • Content-Type: required (string)

    Example:

    application/json

Response 204

No Content

Response 404

Not Found

Body

Media type: application/vnd.api+json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Error Response Schema",
  "description": "Error Response Schema for JSON API",
  "javaType": "org.folio.rest.jaxrs.model.JsonapiError",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errors": {
      "type": "array",
      "description": "Error Response List",
      "items": {
        "type": "object",
        "$ref": "jsonapiErrorResponse.json"
      }
    },
    "jsonapi": {
      "type": "object",
      "description": "JSON API Version",
      "$ref": "jsonapi.json"
    }
  }
}

Example:

{
  "errors": [
    {
      "title": "KB credentials with id '99999999-9999-9999-9999-999999999999' not found"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Response 409

Process of loading holdings is already running

Body

Media type: text/plain

Type: any

Example:

Process of loading holdings is already running

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator