Codex Instances Sources (v1)

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

Table of contents

Codex Instances Sources API

This documents the FOLIO codex instances sources API

Codex instances sources

Codex instances sources

Codex instances sources

GET a list of source modules that implement codex-instances-sources interface

GET /codex-instances-sources
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of codex-instances-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",
        "$ref": "source.json"
      }
    }
  },
  "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-instances-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