Check-in storage (v0.2)

http://localhost:9130

Table of contents

Check-in Storage API

Storage for check-ins

Check-in storage

Collection of check-in items.

GET /check-in-storage/check-ins

Retrieve a list of check-in items.

GET /check-in-storage/check-ins
Query Parameters
  • totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)

    How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

    Example:

    none
  • 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. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

    Example:

    10
  • 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.

    by using CQL

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

itemId="cf23adf0-61ba-4887-bf82-956c4aae2260"

Response 200

Check-in operations that have matched search criteria

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of check-ins",
  "type": "object",
  "properties": {
    "checkIns": {
      "description": "List of check-ins",
      "id": "checkIns",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Check-in operation",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique ID (generated UUID) of the check-in operation",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "occurredDateTime": {
            "type": "string",
            "description": "Date and time when the check-in occurred",
            "format": "date-time"
          },
          "itemId": {
            "type": "string",
            "description": "Id of item that has checked in",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "itemStatusPriorToCheckIn": {
            "type": "string",
            "description": "Item status prior to check-in"
          },
          "requestQueueSize": {
            "type": "integer",
            "description": "Request queue size for the item",
            "minimum": 0
          },
          "itemLocationId": {
            "type": "string",
            "description": "Location of the item in check-in time",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "servicePointId": {
            "type": "string",
            "description": "Service point where the item was checked in",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          },
          "performedByUserId": {
            "type": "string",
            "description": "Id of user that has performed check-in operation",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "uuid.schema",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
          }
        },
        "additionalProperties": false,
        "required": [
          "occurredDateTime",
          "itemId",
          "servicePointId",
          "performedByUserId"
        ]
      }
    },
    "totalRecords": {
      "description": "Number of records",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "checkIns",
    "totalRecords"
  ]
}

Example:

{
  "checkIns": [
    {
      "id": "513eba26-081d-4566-b0eb-c6f2c8db5aab",
      "occurredDateTime": "2020-02-12T16:17:25Z",
      "itemId": "6acb77b5-53f5-4005-b5c2-8ce9c52fb891",
      "itemStatusPriorToCheckIn": "Available",
      "itemLocationId": "99ea6fc9-ed59-45b7-9ae8-1f851ea20208",
      "requestQueueSize": 0,
      "servicePointId": "b0c3c66c-6738-4a61-a51e-8ef354d43e3d",
      "performedByUserId": "f9246eac-ef6f-4043-885b-0325a1e3a9eb"
    }
  ],
  "totalRecords": 1
}

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 check-ins -- 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 check-ins -- unauthorized

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /check-in-storage/check-ins

Create a new check-in item.

POST /check-in-storage/check-ins
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Check-in operation",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique ID (generated UUID) of the check-in operation",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "occurredDateTime": {
      "type": "string",
      "description": "Date and time when the check-in occurred",
      "format": "date-time"
    },
    "itemId": {
      "type": "string",
      "description": "Id of item that has checked in",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "itemStatusPriorToCheckIn": {
      "type": "string",
      "description": "Item status prior to check-in"
    },
    "requestQueueSize": {
      "type": "integer",
      "description": "Request queue size for the item",
      "minimum": 0
    },
    "itemLocationId": {
      "type": "string",
      "description": "Location of the item in check-in time",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "servicePointId": {
      "type": "string",
      "description": "Service point where the item was checked in",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "performedByUserId": {
      "type": "string",
      "description": "Id of user that has performed check-in operation",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "occurredDateTime",
    "itemId",
    "servicePointId",
    "performedByUserId"
  ]
}

Example:

{
  "id": "513eba26-081d-4566-b0eb-c6f2c8db5aab",
  "occurredDateTime": "2020-02-12T16:17:25Z",
  "itemId": "6acb77b5-53f5-4005-b5c2-8ce9c52fb891",
  "itemStatusPriorToCheckIn": "Checked out",
  "itemLocationId": "99ea6fc9-ed59-45b7-9ae8-1f851ea20208",
  "requestQueueSize": 2,
  "servicePointId": "b0c3c66c-6738-4a61-a51e-8ef354d43e3d",
  "performedByUserId": "f9246eac-ef6f-4043-885b-0325a1e3a9eb"
}

Response 201

Check-in operation that has been created

Headers
  • Location: required (string)

    URI to the created check-in item

Body

Media type: application/json

Type: any

Example:

{
  "id": "513eba26-081d-4566-b0eb-c6f2c8db5aab",
  "occurredDateTime": "2020-02-12T16:17:25Z",
  "itemId": "6acb77b5-53f5-4005-b5c2-8ce9c52fb891",
  "itemStatusPriorToCheckIn": "Checked out",
  "itemLocationId": "99ea6fc9-ed59-45b7-9ae8-1f851ea20208",
  "requestQueueSize": 2,
  "servicePointId": "b0c3c66c-6738-4a61-a51e-8ef354d43e3d",
  "performedByUserId": "f9246eac-ef6f-4043-885b-0325a1e3a9eb"
}

Response 400

Supplied entity can not be deserialized

Body

Media type: text/plain

Type: any

Example:

"unable to add check-in -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create check-ins -- unauthorized

Response 422

Supplied entity is not valid per schema

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /check-in-storage/check-ins/{checkInId}

Retrieve check-in item with given {check-inId}

GET /check-in-storage/check-ins/{checkInId}
URI Parameters
  • checkInId: required (string)

Response 200

Check in operation retrieved

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Check-in operation",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique ID (generated UUID) of the check-in operation",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "occurredDateTime": {
      "type": "string",
      "description": "Date and time when the check-in occurred",
      "format": "date-time"
    },
    "itemId": {
      "type": "string",
      "description": "Id of item that has checked in",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "itemStatusPriorToCheckIn": {
      "type": "string",
      "description": "Item status prior to check-in"
    },
    "requestQueueSize": {
      "type": "integer",
      "description": "Request queue size for the item",
      "minimum": 0
    },
    "itemLocationId": {
      "type": "string",
      "description": "Location of the item in check-in time",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "servicePointId": {
      "type": "string",
      "description": "Service point where the item was checked in",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "performedByUserId": {
      "type": "string",
      "description": "Id of user that has performed check-in operation",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "uuid.schema",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "occurredDateTime",
    "itemId",
    "servicePointId",
    "performedByUserId"
  ]
}

Example:

{
  "id": "513eba26-081d-4566-b0eb-c6f2c8db5aab",
  "occurredDateTime": "2020-02-12T16:17:25Z",
  "itemId": "6acb77b5-53f5-4005-b5c2-8ce9c52fb891",
  "itemStatusPriorToCheckIn": "Checked out",
  "itemLocationId": "99ea6fc9-ed59-45b7-9ae8-1f851ea20208",
  "requestQueueSize": 2,
  "servicePointId": "b0c3c66c-6738-4a61-a51e-8ef354d43e3d",
  "performedByUserId": "f9246eac-ef6f-4043-885b-0325a1e3a9eb"
}

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to get retrieve check-in -- unauthorized

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"check-in 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