FOLIO · Schema

baseCircRequestDTO

INN-Reach Circulation Common Put Request Data

CompanyLibrariesLibrary Services PlatformOpen SourceMicroservicesEducation

Properties

Name	Type	Description
transactionTime	integer	Transaction time
patronId	string	Base32-encoded FOLIO user UUID (lowercase, no padding). The caller obtains this value from the patron verification response. Decoded server-side to resolve the FOLIO patron.
patronAgencyCode	string	Patron agency code
itemAgencyCode	string	Item agency code
itemId	string	FOLIO inventory item HRID (Human-Readable ID). Used to look up the item in FOLIO inventory.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/folio/main/json-schema/folio-base-circ-request-dto-schema.json",
  "title": "baseCircRequestDTO",
  "description": "INN-Reach Circulation Common Put Request Data",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/folio-mod-inn-reach-circulation-openapi.yml#/components/schemas/baseCircRequestDTO",
  "type": "object",
  "properties": {
    "transactionTime": {
      "description": "Transaction time",
      "type": "integer"
    },
    "patronId": {
      "description": "Base32-encoded FOLIO user UUID (lowercase, no padding). The caller obtains this value from the patron verification response. Decoded server-side to resolve the FOLIO patron.",
      "type": "string",
      "pattern": "[a-z,0-9]{1,32}"
    },
    "patronAgencyCode": {
      "description": "Patron agency code",
      "type": "string",
      "pattern": "[a-z,0-9]{5}"
    },
    "itemAgencyCode": {
      "description": "Item agency code",
      "type": "string",
      "pattern": "[a-z,0-9]{5}"
    },
    "itemId": {
      "description": "FOLIO inventory item HRID (Human-Readable ID). Used to look up the item in FOLIO inventory.",
      "type": "string",
      "pattern": "[a-z,0-9]{1,32}"
    }
  },
  "additionalProperties": false,
  "required": [
    "transactionTime",
    "patronId",
    "patronAgencyCode",
    "itemAgencyCode",
    "itemId"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/folio-base-circ-request-dto"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.