Request Storage Batch (v0.3)

http://localhost:9130

Table of contents

Batch Request Storage API

Batch request operations

/request-storage-batch

POST /request-storage-batch/requests

POST /request-storage-batch/requests
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of requests",
  "type": "object",
  "properties": {
    "requests": {
      "description": "List of request items to update",
      "id": "requests",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "A request by a patron for a specific item",
        "properties": {
          "id": {
            "description": "UUID of the request",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          "requestType": {
            "description": "Whether the item should be held upon return, recalled or paged for",
            "type": "string",
            "enum": [
              "Hold",
              "Recall",
              "Page"
            ]
          },
          "requestDate": {
            "description": "Date the request was made",
            "type": "string",
            "format": "date-time"
          },
          "patronComments": {
            "description": "Comments made by the patron",
            "type": "string"
          },
          "requesterId": {
            "description": "ID of the requesting patron (user)",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          "proxyUserId": {
            "description": "ID of the user representing a proxy for the patron",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          "itemId": {
            "description": "ID of the item being requested",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          "status": {
            "description": "Status of the request",
            "type": "string",
            "enum": [
              "Open - Not yet filled",
              "Open - Awaiting pickup",
              "Open - In transit",
              "Open - Awaiting delivery",
              "Closed - Filled",
              "Closed - Cancelled",
              "Closed - Unfilled",
              "Closed - Pickup expired"
            ]
          },
          "cancellationReasonId": {
            "description": "The id of the relevant request reason",
            "type": "string"
          },
          "cancelledByUserId": {
            "description": "The id of the user that cancelled the request",
            "type": "string"
          },
          "cancellationAdditionalInformation": {
            "description": "Potential relevant information regarding a cancellation",
            "type": "string"
          },
          "cancelledDate": {
            "description": "Date the request was cancelled",
            "type": "string",
            "format": "date-time"
          },
          "position": {
            "description": "position of the request in a per-item request queue",
            "type": "integer"
          },
          "item": {
            "description": "Copy of some item metadata (used for searching and sorting)",
            "type": "object",
            "properties": {
              "title": {
                "description": "title of the item",
                "type": "string"
              },
              "barcode": {
                "description": "barcode of the item",
                "type": "string"
              },
              "identifiers": {
                "type": "array",
                "description": "An extensible set of name-value pairs of identifiers associated with the resource",
                "minItems": 0,
                "items": {
                  "type": "object",
                  "properties": {
                    "value": {
                      "type": "string",
                      "description": "Resource identifier value"
                    },
                    "identifierTypeId": {
                      "type": "string",
                      "description": "UUID of resource identifier type (e.g. ISBN, ISSN, LCCN, CODEN, Locally defined identifiers)",
                      "$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": [
                    "value",
                    "identifierTypeId"
                  ]
                }
              }
            },
            "additionalProperties": false
          },
          "requester": {
            "description": "Copy of some requesting patron metadata (used for searching and sorting)",
            "type": "object",
            "properties": {
              "firstName": {
                "description": "first name of the requesting patron",
                "type": "string"
              },
              "lastName": {
                "description": "last name of the requesting patron",
                "type": "string"
              },
              "middleName": {
                "description": "middle name of the requesting patron",
                "type": "string"
              },
              "barcode": {
                "description": "barcode of the requesting patron",
                "type": "string"
              },
              "patronGroup": {
                "description": "DEPRECATED, to be removed in subsequent major version",
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "proxy": {
            "description": "Copy of some proxy patron metadata (used for searching and sorting)",
            "type": "object",
            "properties": {
              "firstName": {
                "description": "first name of the proxy patron",
                "type": "string"
              },
              "lastName": {
                "description": "last name of the proxy patron",
                "type": "string"
              },
              "middleName": {
                "description": "middle name of the proxy patron",
                "type": "string"
              },
              "barcode": {
                "description": "barcode of the proxy patron",
                "type": "string"
              },
              "patronGroup": {
                "description": "DEPRECATED, to be removed in subsequent major version",
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "fulfilmentPreference": {
            "description": "How should the request be fulfilled (whether the item should be kept on the hold shelf for collection or delivered to the requester)",
            "type": "string",
            "enum": [
              "Hold Shelf",
              "Delivery"
            ]
          },
          "deliveryAddressTypeId": {
            "description": "Deliver to the address of this type, for the requesting patron",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          "requestExpirationDate": {
            "description": "Date when the request expires",
            "type": "string",
            "format": "date-time"
          },
          "holdShelfExpirationDate": {
            "description": "Date when an item returned to the hold shelf expires",
            "type": "string",
            "format": "date-time"
          },
          "pickupServicePointId": {
            "description": "The ID of the Service Point where this request can be picked up",
            "type": "string",
            "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
          },
          "metadata": {
            "description": "Metadata about creation and changes to requests, provided by the server (client should not provide)",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          },
          "tags": {
            "type": "object",
            "description": "Tags",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "tags.schema",
            "title": "tags",
            "properties": {
              "tagList": {
                "description": "List of tags",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "awaitingPickupRequestClosedDate": {
            "description": "A date when the request with awaiting pickup status was closed",
            "type": "string",
            "format": "date-time",
            "readonly": true
          }
        },
        "additionalProperties": false,
        "required": [
          "itemId",
          "requesterId",
          "requestType",
          "requestDate",
          "fulfilmentPreference"
        ]
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "requests"
  ]
}

Response 201

Update executed successfully

Response 422

Validation errors

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, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator