Instance note types API API documentation

/instance-note-types

Collection of instance-note-type items.

/instance-note-types get post

get

Return a list of instance note types

post

Create a new instance note type

Return a list of instance note types

Request
Response

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]

HTTP status code 200

Returns a list of instance-note-type items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of Instance note types",
  "type": "object",
  "properties": {
    "instanceNoteTypes": {
      "description": "List of Instance note types",
      "id": "instanceNoteType",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "instancenotetype.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "instanceNoteTypes",
    "totalRecords"
  ]
}

Example:

{
  "instanceNoteTypes": [
    {
      "id": "b6f7a05c-6eb5-46cd-9d62-ca2700171190",
      "name": "Note",
      "source": "folio"
    },
    {
      "id": "a81057f5-2a4c-4fb5-9ddd-9aa0e11c4ab4",
      "name": "Action note",
      "source": "folio"
    }
  ],
  "totalRecords": 2
}

HTTP status code 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 instance-note-types -- malformed parameter 'query', syntax error at column 6

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list instance-note-types -- unauthorized

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Create a new instance note type

Request
Response

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 Instance note type",
  "type": "object",
  "properties": {
    "id": {
      "description": "unique ID of the Instance note type; a UUID",
      "$ref": "uuid.json"
    },
    "name": {
      "type": "string",
      "description": "name of the Instance note type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the Instance note type 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": "b6f7a05c-6eb5-46cd-9d62-ca2700171190",
  "name": "Note",
  "source": "folio"
}

HTTP status code 201

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

Headers

Location: required(string)
URI to the created instance-note-type item

Body

Media type: application/json

Type: any

Example:

{
  "id": "b6f7a05c-6eb5-46cd-9d62-ca2700171190",
  "name": "Note",
  "source": "folio"
}

HTTP status code 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 instance-note-type -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create instance-note-types -- unauthorized

HTTP status code 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": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

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

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

/instance-note-types/{id} get delete put

Pass in the instance note type id

get

Retrieve instance-note-type item with given {instance-note-typeId}

delete

Delete instance-note-type item with given {instance-note-typeId}

put

Update instance-note-type item with given {instance-note-typeId}

Retrieve instance-note-type item with given {instance-note-typeId}

Request
Response

URI Parameters

id: required(string)

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

HTTP status code 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 Instance note type",
  "type": "object",
  "properties": {
    "id": {
      "description": "unique ID of the Instance note type; a UUID",
      "$ref": "uuid.json"
    },
    "name": {
      "type": "string",
      "description": "name of the Instance note type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the Instance note type 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": "b6f7a05c-6eb5-46cd-9d62-ca2700171190",
  "name": "Note",
  "source": "folio"
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"instance-note-type not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Delete instance-note-type item with given {instance-note-typeId}

Request
Response

URI Parameters

id: required(string)

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

HTTP status code 204

Item deleted successfully

HTTP status code 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 instance-note-type -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"instance-note-type not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Update instance-note-type item with given {instance-note-typeId}

Request
Response

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 Instance note type",
  "type": "object",
  "properties": {
    "id": {
      "description": "unique ID of the Instance note type; a UUID",
      "$ref": "uuid.json"
    },
    "name": {
      "type": "string",
      "description": "name of the Instance note type"
    },
    "source": {
      "type": "string",
      "description": "label indicating where the Instance note type 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": "b6f7a05c-6eb5-46cd-9d62-ca2700171190",
  "name": "Note",
  "source": "folio"
}

HTTP status code 204

Item successfully updated

HTTP status code 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 instance-note-type -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"instance-note-type not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Instance note types API API documentation version v1.0