Codex Packages (v1)

https://github.com/folio-org/mod-codex-ekb

Codex Packages API
Codex packages
- GET /codex-packages
- GET /codex-packages/{id}
Codex packages sources
- Codex sources

Codex Packages API

This documents the FOLIO codex packages API

Codex packages

Codex packages collection

GET /codex-packages

Retrieve a list of codex-package items.

GET /codex-packages

Query Parameters

query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example name = academic
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

name=academic
```
totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
none
```
offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
```
0
```
limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
10
```

Response 200

Returns a list of codex-package items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "additionalProperties": false,
  "description": "Collection of packages",
  "properties": {
    "packages": {
      "type": "array",
      "description": "Collection of packages",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Codex Package Schema",
        "description": "Codex Package Schema",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "The internal ID of the Package record as known by the source, unique and can have different formats"
          },
          "identifier": {
            "type": "string",
            "description": "An external identifier used to track the Package (e.g. a barcode)"
          },
          "name": {
            "type": "string",
            "description": "A name (or label) associated with the Package"
          },
          "description": {
            "type": "string",
            "description": "A free-form description of the Package"
          },
          "type": {
            "type": "string",
            "description": "The type of package - what sort of collection does it represent. (e.g. DVD box set; boundwidth; archival cardboard box; etc..)",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Package Type Schema",
            "additionalProperties": false,
            "enum": [
              "aggregatedfulltext",
              "abstractandindex",
              "ebook",
              "ejournal",
              "print",
              "unknown",
              "onlinereference",
              "streamingmedia",
              "mixedcontent"
            ]
          },
          "providerId": {
            "type": "string",
            "description": "Link to provider object associated with this resource (could be in another domain)"
          },
          "provider": {
            "type": "string",
            "description": "Name of provider for display purposes"
          },
          "platform": {
            "type": "string",
            "description": "Platform hosting the e-resource"
          },
          "itemCount": {
            "type": "integer",
            "description": "Number of items in the package"
          },
          "coverage": {
            "type": "object",
            "description": "Coverage date for the package itself, rather than its contents",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Coverage Schema",
            "additionalProperties": false,
            "properties": {
              "beginCoverage": {
                "type": "string",
                "format": "date",
                "customPattern": "yyyy-MM-dd",
                "description": "Begin Coverage Date",
                "example": "2018-01-01"
              },
              "endCoverage": {
                "type": "string",
                "format": "date",
                "customPattern": "yyyy-MM-dd",
                "description": "End Coverage Date",
                "example": "2018-12-01"
              }
            }
          },
          "isSelected": {
            "type": "object",
            "description": "Selection state (`is it held?`) of the package itself, rather than its contents. Mostly relevant for e-resources",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Selection Status Schema",
            "additionalProperties": false,
            "enum": [
              "Yes",
              "No",
              "NotSpecified"
            ]
          },
          "source": {
            "type": "string",
            "description": "a label indicating the source of the package, e.g. kb, local"
          },
          "lastModified": {
            "type": "string",
            "description": "date when this package was last modified"
          }
        },
        "required": [
          "id",
          "name"
        ]
      }
    },
    "resultInfo": {
      "description": "Result information schema",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "resultInfo.schema",
      "type": "object",
      "properties": {
        "totalRecords": {
          "type": "integer",
          "description": "Estimated or exact total number of records. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords"
        },
        "totalRecordsEstimated": {
          "type": "boolean",
          "description": "True if totalRecords is an estimation, false if it is the exact number"
        },
        "totalRecordsRounded": {
          "type": "integer",
          "description": "The rounded value of totalRecords if totalRecords is an estimation"
        },
        "responseTime": {
          "type": "number",
          "description": "Response time"
        },
        "facets": {
          "type": "array",
          "description": "Array of facets",
          "items": {
            "type": "object",
            "description": "A facet",
            "properties": {
              "facetValues": {
                "type": "array",
                "description": "Array of facet values",
                "items": {
                  "type": "object",
                  "description": "A facet value",
                  "properties": {
                    "count": {
                      "type": "integer",
                      "description": "Count of facet values"
                    },
                    "value": {
                      "description": "Value Object"
                    }
                  }
                },
                "additionalProperties": false
              },
              "type": {
                "type": "string",
                "description": "Type of facet"
              }
            },
            "additionalProperties": false
          }
        },
        "diagnostics": {
          "type": "array",
          "description": "Array of diagnostic information",
          "items": {
            "type": "object",
            "description": "Diagnostic information",
            "properties": {
              "source": {
                "type": "string",
                "description": "Source reporting the diagnostic information"
              },
              "code": {
                "type": "string",
                "description": "Diagnostic Code"
              },
              "message": {
                "type": "string",
                "description": "Diagnostic Message"
              },
              "module": {
                "type": "string",
                "description": "Module reporting diagnostic information"
              },
              "recordCount": {
                "type": "integer",
                "description": "Record Count for diagnostics"
              },
              "query": {
                "type": "string",
                "description": "CQL Query associated with results"
              }
            }
          }
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "packages",
    "resultInfo"
  ]
}

Example:

{
  "instances": [
    {
      "id": "18-134",
      "identifier": "",
      "name": "Academic ASAP",
      "description": "",
      "type": "Aggregated Full Text",
      "providerId": "18",
      "provider": "Gale|Cengage",
      "platform": "",
      "itemCount": 100,
      "coverage": {
        "beginCoverage": "2018-08-13",
        "endCoverage": "2018-09-13"
      },
      "isSelected": "Yes",
      "source": "ekb",
      "lastModified": "2019-02-11"
    },
    {
      "id": "bfcefc83-4a2f-44f0-ac1f-ba2424cea48a",
      "identifier": "",
      "name": "Academic OneFile",
      "description": "Academic OneFile description",
      "type": "Online Reference",
      "providerId": "bfcefc83-4a2f-44f0-ac1f-ba2424cea48b",
      "provider": "Gale|Cengage",
      "platform": "Gale|Cengage platform",
      "itemCount": 100,
      "coverage": {
        "beginCoverage": "2018-08-13",
        "endCoverage": "2018-09-13"
      },
      "isSelected": "NotSpecified",
      "source": "localkb",
      "lastModified": "2019-02-11"
    }
  ],
  "resultInfo": {
    "totalRecords": 2,
    "facets": [],
    "diagnostics": [
      {
        "source": "mod-agreements-1.0.2",
        "code": "200",
        "recordCount": 1,
        "query": "(name = a) sortby name"
      },
      {
        "source": "mod-codex-ekb-1.1.0",
        "code": "200",
        "recordCount": 1,
        "query": "(name = a) sortby name"
      }
    ]
  }
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list codex-packages -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

"unable to list packages -- unauthorized"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

GET /codex-packages/{id}

Retrieve codex-package item with given {codex-packageId}

GET /codex-packages/{id}

URI Parameters

id: required (string)

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Codex Package Schema",
  "description": "Codex Package Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "description": "The internal ID of the Package record as known by the source, unique and can have different formats"
    },
    "identifier": {
      "type": "string",
      "description": "An external identifier used to track the Package (e.g. a barcode)"
    },
    "name": {
      "type": "string",
      "description": "A name (or label) associated with the Package"
    },
    "description": {
      "type": "string",
      "description": "A free-form description of the Package"
    },
    "type": {
      "type": "string",
      "description": "The type of package - what sort of collection does it represent. (e.g. DVD box set; boundwidth; archival cardboard box; etc..)",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Package Type Schema",
      "additionalProperties": false,
      "enum": [
        "aggregatedfulltext",
        "abstractandindex",
        "ebook",
        "ejournal",
        "print",
        "unknown",
        "onlinereference",
        "streamingmedia",
        "mixedcontent"
      ]
    },
    "providerId": {
      "type": "string",
      "description": "Link to provider object associated with this resource (could be in another domain)"
    },
    "provider": {
      "type": "string",
      "description": "Name of provider for display purposes"
    },
    "platform": {
      "type": "string",
      "description": "Platform hosting the e-resource"
    },
    "itemCount": {
      "type": "integer",
      "description": "Number of items in the package"
    },
    "coverage": {
      "type": "object",
      "description": "Coverage date for the package itself, rather than its contents",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Coverage Schema",
      "additionalProperties": false,
      "properties": {
        "beginCoverage": {
          "type": "string",
          "format": "date",
          "customPattern": "yyyy-MM-dd",
          "description": "Begin Coverage Date",
          "example": "2018-01-01"
        },
        "endCoverage": {
          "type": "string",
          "format": "date",
          "customPattern": "yyyy-MM-dd",
          "description": "End Coverage Date",
          "example": "2018-12-01"
        }
      }
    },
    "isSelected": {
      "type": "object",
      "description": "Selection state (`is it held?`) of the package itself, rather than its contents. Mostly relevant for e-resources",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "title": "Selection Status Schema",
      "additionalProperties": false,
      "enum": [
        "Yes",
        "No",
        "NotSpecified"
      ]
    },
    "source": {
      "type": "string",
      "description": "a label indicating the source of the package, e.g. kb, local"
    },
    "lastModified": {
      "type": "string",
      "description": "date when this package was last modified"
    }
  },
  "required": [
    "id",
    "name"
  ]
}

Example:

{
  "id": "bfcefc83-4a2f-44f0-ac1f-ba2424cea48a",
  "identifier": "",
  "name": "Academic OneFile",
  "description": "Academic OneFile description",
  "type": "Online Reference",
  "providerId": "18",
  "provider": "Gale|Cengage",
  "platform": "Gale|Cengage platform",
  "itemCount": 100,
  "coverage":{"beginCoverage":"2018-08-13","endCoverage":"2018-09-13"},
  "source": "localkb",
  "isSelected": "NotSpecified",
  "lastModified": "2019-02-11"
}

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to get retrieve codex-package -- unauthorized

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"codex-package not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Codex packages sources

Codex sources

GET a list of source modules that implement codex-packages interface

GET /codex-packages-sources

Response 200

Returns a list of codex-packages-source items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "additionalProperties": false,
  "description": "Collection of sources",
  "properties": {
    "sources": {
      "type": "array",
      "description": "Collection of sources",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Codex Source schema",
        "description": "Codex Source schema",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "description": "short identifier for the module -- for example (kb, localekb)"
          },
          "name": {
            "type": "string",
            "description": "Module name and version -- for example (mod-codex-ekb-1.1.0, mod-agreements-1.0.2)"
          }
        },
        "required": [
          "id",
          "name"
        ]
      }
    }
  },
  "required": [
    "sources"
  ]
}

Example:

{
  "source": [
    {
      "id": "ekb",
      "name": "mod-codex-ekb-1.1.0"
    },
    {
      "id": "localekb",
      "name": "mod-agreements-1.0.2"
    }
  ]
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list codex-packages-sources -- malformed parameter 'query', syntax error at column 6

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Codex Packages (v1)

Table of contents

Codex Packages API

Codex packages

GET /codex-packages

Query Parameters

Response 200

Response 400

Response 401

Response 422

Response 500

GET /codex-packages/{id}

URI Parameters

Response 200

Response 401

Response 404

Response 500

Codex packages sources

Codex sources

Response 200

Response 400

Response 500