ILL policy API (v1.0)

http://github.com/org/folio/mod-inventory-storage

Table of contents

ILL policy API

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

/ill-policies

Collection of ill-policy items.

GET /ill-policies

Return a list of ILL policy types

GET /ill-policies
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

    Example:

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

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of ILL policies",
  "type": "object",
  "properties": {
    "illPolicies": {
      "description": "List of ILL policies",
      "id": "illPolicy",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "illpolicy.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "illPolicies",
    "totalRecords"
  ]
}

Example:

{
  "id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
  "name": "Will lend",
  "source": "folio"
},
{
  "id": "38852045-aeed-45b4-ac02-db44fd09798e",
  "name": "Will not lend",
  "source": "folio"
}

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 ill-policies -- 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 ill-policies -- 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 /ill-policies

Create a new ILL policy

POST /ill-policies
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#",
  "description": "An ILL policy",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the ILL policy; UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the policy"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the ILL policy entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}

Example:

{
  "id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
  "name": "Will lend",
  "source": "folio"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created ill-policy item

Body

Media type: application/json

Type: any

Example:

{
  "id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
  "name": "Will lend",
  "source": "folio"
}

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 ill-policy -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create ill-policies -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "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 /ill-policies/{id}

Retrieve ill-policy item with given {ill-policyId}

GET /ill-policies/{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#",
  "description": "An ILL policy",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the ILL policy; UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the policy"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the ILL policy entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}

Example:

{
  "id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
  "name": "Will lend",
  "source": "folio"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ill-policy 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 /ill-policies/{id}

Delete ill-policy item with given {ill-policyId}

DELETE /ill-policies/{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 ill-policy -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ill-policy 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 /ill-policies/{id}

Update ill-policy item with given {ill-policyId}

PUT /ill-policies/{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#",
  "description": "An ILL policy",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the ILL policy; UUID"
    },
    "name": {
      "type": "string",
      "description": "name of the policy"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the ILL policy entry originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "source"
  ]
}

Example:

{
  "id": "596c920f-f33e-4bee-b8bc-98bb2bbc4978",
  "name": "Will lend",
  "source": "folio"
}

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 ill-policy -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ill-policy 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