Statistical code reference API (v1.0)

http://localhost

Table of contents

Statistical code reference API

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

/statistical-codes

Collection of statistical-code items.

GET /statistical-codes

Return a list of statistical codes

GET /statistical-codes
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 statistical-code items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of statistical codes",
  "type": "object",
  "properties": {
    "statisticalCodes": {
      "description": "List of statistical codes",
      "id": "statisticalCode",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "statisticalcode.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "statisticalCode",
    "totalRecords"
  ]
}


Example:

{
  "id": "f5f97be7-4803-496b-807e-ca013433953f",
  "code": "ASER",
  "name": "Active serial",
  "statisticalCodeTypeId": "3abd6fc2-b3e4-4879-b1e1-78be41769fe3",
  "source": "example"
},
{
  "id": "2be68aea-b147-473a-b6c2-19e5cbb01194",
  "code": "books",
  "name": "Books, prints (books)",
  "statisticalCodeTypeId": "39511666-83a8-4206-96a8-9c5823248e10",
  "source": "example"
}

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 statistical-codes -- 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 statistical-codes -- 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 /statistical-codes

Create a new statistical code

POST /statistical-codes
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": "A statistical code",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the statistical code; a UUID"
    },
    "code": {
      "type": "string",
      "description": "statistical code; a distinct label"
    },
    "name": {
      "type": "string",
      "description": "name or description of a statistical code"
    },
    "statisticalCodeTypeId": {
      "type": "string",
      "description": "a UUID referencing a statistical code type"
    },
    "source": {
      "source": "string",
      "description": "label indicating where the statistical code originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "code",
    "name",
    "statisticalCodeTypeId",
    "source"
  ]
}

Example:

{
  "id": "f5f97be7-4803-496b-807e-ca013433953f",
  "code": "ASER",
  "name": "Active serial",
  "statisticalCodeTypeId": "3abd6fc2-b3e4-4879-b1e1-78be41769fe3",
  "source": "example"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created statistical-code item

Body

Media type: application/json

Type: any

Example:

{
  "id": "f5f97be7-4803-496b-807e-ca013433953f",
  "code": "ASER",
  "name": "Active serial",
  "statisticalCodeTypeId": "3abd6fc2-b3e4-4879-b1e1-78be41769fe3",
  "source": "example"
}

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 statistical-code -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create statistical-codes -- 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 /statistical-codes/{statisticalCodeId}

Retrieve statistical-code item with given {statistical-codeId}

GET /statistical-codes/{statisticalCodeId}
URI Parameters
  • statisticalCodeId: 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": "A statistical code",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the statistical code; a UUID"
    },
    "code": {
      "type": "string",
      "description": "statistical code; a distinct label"
    },
    "name": {
      "type": "string",
      "description": "name or description of a statistical code"
    },
    "statisticalCodeTypeId": {
      "type": "string",
      "description": "a UUID referencing a statistical code type"
    },
    "source": {
      "source": "string",
      "description": "label indicating where the statistical code originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "code",
    "name",
    "statisticalCodeTypeId",
    "source"
  ]
}

Example:

{
  "id": "f5f97be7-4803-496b-807e-ca013433953f",
  "code": "ASER",
  "name": "Active serial",
  "statisticalCodeTypeId": "3abd6fc2-b3e4-4879-b1e1-78be41769fe3",
  "source": "example"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"statistical-code 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 /statistical-codes/{statisticalCodeId}

Delete statistical-code item with given {statistical-codeId}

DELETE /statistical-codes/{statisticalCodeId}
URI Parameters
  • statisticalCodeId: 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 statistical-code -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"statistical-code 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 /statistical-codes/{statisticalCodeId}

Update statistical-code item with given {statistical-codeId}

PUT /statistical-codes/{statisticalCodeId}
URI Parameters
  • statisticalCodeId: 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": "A statistical code",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "unique ID of the statistical code; a UUID"
    },
    "code": {
      "type": "string",
      "description": "statistical code; a distinct label"
    },
    "name": {
      "type": "string",
      "description": "name or description of a statistical code"
    },
    "statisticalCodeTypeId": {
      "type": "string",
      "description": "a UUID referencing a statistical code type"
    },
    "source": {
      "source": "string",
      "description": "label indicating where the statistical code originates from, i.e. 'folio' or 'local'"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "code",
    "name",
    "statisticalCodeTypeId",
    "source"
  ]
}

Example:

{
  "id": "f5f97be7-4803-496b-807e-ca013433953f",
  "code": "ASER",
  "name": "Active serial",
  "statisticalCodeTypeId": "3abd6fc2-b3e4-4879-b1e1-78be41769fe3",
  "source": "example"
}

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 statistical-code -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"statistical-code 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