Isils (v1.0.1)

http://github.com/org/folio/mod-finc-config

Table of contents

mod-finc-config Isils API

This documents the API calls that can be made to query and manage isils of the system

/finc-config/isils

Collection of isil items.

GET /finc-config/isils

Return a list of isisls

GET /finc-config/isils
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.

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    
    
  • 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

    Example:

    10
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of isil items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Collection of isil to tenant configurations",
  "properties": {
    "isils": {
      "description": "List of isil items",
      "id": "isils",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "isil.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  }
}

Example:

{
  "isils": [
    {
      "library": "UB Leipzig",
      "isil": "DE-15",
      "tenant": "ubl",
      "id": "5da17580-5d30-4b75-aafb-1317bafad827"
    },
    {
      "library": "SLUB Dresden",
      "isil": "DE-14",
      "tenant": "slub",
      "id": "8d7bc408-4ce9-4bba-992b-bc2118366faf"
    }
  ],
  "totalRecords": 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 isils -- 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 isils -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /finc-config/isils

Create an isil

POST /finc-config/isils
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "Isil",
  "description": "Isil to tenant configuration",
  "properties": {
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "library": {
      "description": "Descriptive name of the library",
      "type": "string"
    },
    "isil": {
      "description": "Isil of this library",
      "type": "string"
    },
    "tenant": {
      "description": "Tenant of this library",
      "type": "string"
    },
    "metadata": {
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "library",
    "isil",
    "tenant"
  ]
}

Example:

{
  "id": "5da17580-5d30-4b75-aafb-1317bafad827",
  "library": "UB Leipzig",
  "isil": "DE-15",
  "tenant": "ubl"
}

Response 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers
  • Location: required (string)

    URI to the created isil item

Body

Media type: application/json

Type: any

Example:

{
  "id": "5da17580-5d30-4b75-aafb-1317bafad827",
  "library": "UB Leipzig",
  "isil": "DE-15",
  "tenant": "ubl"
}

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 add isil -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create isils -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "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 /finc-config/isils/{id}

Retrieve isil item with given {isilId}

GET /finc-config/isils/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "Isil",
  "description": "Isil to tenant configuration",
  "properties": {
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "library": {
      "description": "Descriptive name of the library",
      "type": "string"
    },
    "isil": {
      "description": "Isil of this library",
      "type": "string"
    },
    "tenant": {
      "description": "Tenant of this library",
      "type": "string"
    },
    "metadata": {
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "library",
    "isil",
    "tenant"
  ]
}

Example:

{
  "id": "5da17580-5d30-4b75-aafb-1317bafad827",
  "library": "UB Leipzig",
  "isil": "DE-15",
  "tenant": "ubl"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"isil 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

DELETE /finc-config/isils/{id}

Delete isil item with given {isilId}

DELETE /finc-config/isils/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

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 delete isil -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"isil 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

PUT /finc-config/isils/{id}

Update isil item with given {isilId}

PUT /finc-config/isils/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "Isil",
  "description": "Isil to tenant configuration",
  "properties": {
    "id": {
      "description": "A UUID identifying this group",
      "type": "string"
    },
    "library": {
      "description": "Descriptive name of the library",
      "type": "string"
    },
    "isil": {
      "description": "Isil of this library",
      "type": "string"
    },
    "tenant": {
      "description": "Tenant of this library",
      "type": "string"
    },
    "metadata": {
      "$ref": "../raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "library",
    "isil",
    "tenant"
  ]
}

Example:

{
  "id": "5da17580-5d30-4b75-aafb-1317bafad827",
  "library": "UB Leipzig",
  "isil": "DE-15",
  "tenant": "ubl"
}

Response 204

Item successfully updated

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 update isil -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"isil 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