Request Storage Batch version v2.0

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}$"
          },
          "requestLevel": {
            "description": "Level of the request - Item or Title",
            "type": "string",
            "enum": [
              "Item",
              "Title"
            ]
          },
          "requestType": {
            "description": "Whether the item should be held upon return, recalled or paged for",
            "type": "string",
            "enum": [
              "Hold",
              "Recall",
              "Page"
            ]
          },
          "ecsRequestPhase": {
            "description": "Stage in ECS request process, absence of this field means this is a single-tenant request",
            "type": "string",
            "enum": [
              "Primary",
              "Secondary",
              "Intermediate"
            ]
          },
          "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}$"
          },
          "instanceId": {
            "description": "ID of the instance being requested",
            "type": "string",
            "$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}$"
          },
          "holdingsRecordId": {
            "description": "ID of the holdings record being requested",
            "type": "string",
            "$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}$"
          },
          "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 the unified request queue",
            "type": "integer"
          },
          "instance": {
            "description": "Copy of some instance metadata (used for searching and sorting)",
            "type": "object",
            "properties": {
              "title": {
                "description": "title 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"
                  ]
                }
              }
            }
          },
          "item": {
            "description": "Copy of some item metadata (used for searching and sorting)",
            "type": "object",
            "properties": {
              "barcode": {
                "description": "barcode of the item",
                "type": "string"
              },
              "itemEffectiveLocationId": {
                "description": "Item's effective location",
                "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}$"
              },
              "itemEffectiveLocationName": {
                "description": "Item's effective location name",
                "type": "string"
              },
              "retrievalServicePointId": {
                "description": "Item's location primary service point",
                "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}$"
              },
              "retrievalServicePointName": {
                "description": "Item's location primary service point name",
                "type": "string"
              }
            },
            "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
          },
          "fulfillmentPreference": {
            "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
          },
          "printDetails": {
            "type": "object",
            "description": "PrintDetails",
            "properties": {
              "printCount": {
                "type": "integer",
                "description": "Number of times print slip generated."
              },
              "requesterId": {
                "type": "string",
                "description": "UUID of print slip requester."
              },
              "isPrinted": {
                "type": "boolean",
                "description": "Whether print slip was printed in past."
              },
              "printEventDate": {
                "type": "string",
                "format": "date-time",
                "description": "Date and time when print slip was generated last time."
              }
            },
            "additionalProperties": false
          },
          "awaitingPickupRequestClosedDate": {
            "description": "A date when the request with awaiting pickup status was closed",
            "type": "string",
            "format": "date-time",
            "readonly": true
          },
          "searchIndex": {
            "description": "Request fields used for search",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "callNumberComponents": {
                "type": "object",
                "description": "Effective call number components",
                "properties": {
                  "callNumber": {
                    "type": "string",
                    "description": "Effective Call Number is an identifier assigned to an item or its holding and associated with the item."
                  },
                  "prefix": {
                    "type": "string",
                    "description": "Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item."
                  },
                  "suffix": {
                    "type": "string",
                    "description": "Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item."
                  }
                },
                "additionalProperties": false
              },
              "shelvingOrder": {
                "type": "string",
                "description": "A system generated normalization of the call number that allows for call number sorting in reports and search results"
              },
              "pickupServicePointName": {
                "description": "The name of the request pickup service point",
                "type": "string"
              }
            },
            "additionalProperties": false
          },
          "itemLocationCode": {
            "description": "Allow specifying item location when creating title-level requests",
            "type": "string"
          },
          "isDcbReRequestCancellation": {
            "description": "Indicates if the request was cancelled during a DCB transaction update. This determines whether the Kafka event will be handled and if an email notification will be sent",
            "type": "boolean"
          }
        },
        "additionalProperties": false,
        "required": [
          "instanceId",
          "requesterId",
          "requestType",
          "requestLevel",
          "requestDate",
          "fulfillmentPreference",
          "status"
        ]
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "requests"
  ]
}