WorldCat Member General Holdings API

openapi: 3.2.0
info:
  description: Searching of WorldCat
  version: 2.0.0
  title: WorldCat Search API v. 2 Member General Holdings API
servers:
- url: https://americas.discovery.api.oclc.org
  description: PROD
tags:
- name: Member General Holdings
paths:
  /worldcat/search/v2/bibs-summary-holdings:
    get:
      tags:
      - Member General Holdings
      summary: Get summary of holdings for a known item
      description: Given a known item, get summary of holdings
      operationId: find-bib-summary-holdings
      parameters:
      - $ref: '#/components/parameters/accept'
      - $ref: '#/components/parameters/oclcNumber'
      - $ref: '#/components/parameters/isbn'
      - $ref: '#/components/parameters/issn'
      - $ref: '#/components/parameters/holdingsAllEditions'
      - $ref: '#/components/parameters/holdingsAllVariantRecords'
      - $ref: '#/components/parameters/preferredLanguage'
      - $ref: '#/components/parameters/holdingsFilterFormat'
      - $ref: '#/components/parameters/heldInCountry'
      - $ref: '#/components/parameters/heldInState'
      - $ref: '#/components/parameters/heldByGroup'
      - $ref: '#/components/parameters/heldBy'
      - $ref: '#/components/parameters/heldBySymbol'
      - $ref: '#/components/parameters/heldByInstitutionID'
      - $ref: '#/components/parameters/heldByLibraryType'
      - $ref: '#/components/parameters/lat'
      - $ref: '#/components/parameters/lon'
      - $ref: '#/components/parameters/distance'
      - $ref: '#/components/parameters/unit'
      responses:
        '200':
          $ref: '#/components/responses/success-bibs-summary-holdings'
        '400':
          $ref: '#/components/responses/bib_holding_query_error'
        '405':
          $ref: '#/components/responses/method-not-supported'
        '406':
          $ref: '#/components/responses/failed-not-acceptable'
        '500':
          $ref: '#/components/responses/internal-server-error'
      security:
      - worldcat_search_auth:
        - wcapi:view_summary_holdings
  /worldcat/search/v2/bibs-holdings:
    get:
      tags:
      - Member General Holdings
      summary: Find member holdings for a known item
      description: Given a known item, find the member libraries who hold it
      operationId: find-bib-holdings
      parameters:
      - $ref: '#/components/parameters/accept'
      - $ref: '#/components/parameters/oclcNumber'
      - $ref: '#/components/parameters/isbn'
      - $ref: '#/components/parameters/issn'
      - $ref: '#/components/parameters/holdingsAllEditions'
      - $ref: '#/components/parameters/holdingsAllVariantRecords'
      - $ref: '#/components/parameters/preferredLanguage'
      - $ref: '#/components/parameters/holdingsFilterFormat'
      - $ref: '#/components/parameters/heldInCountry'
      - $ref: '#/components/parameters/heldInState'
      - $ref: '#/components/parameters/heldBySymbol'
      - $ref: '#/components/parameters/heldByInstitutionID'
      - $ref: '#/components/parameters/heldByLibraryType'
      - $ref: '#/components/parameters/lat'
      - $ref: '#/components/parameters/lon'
      - $ref: '#/components/parameters/distance'
      - $ref: '#/components/parameters/unit'
      - $ref: '#/components/parameters/numberNearestHoldings'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/itemType'
      - $ref: '#/components/parameters/itemSubType'
      responses:
        '200':
          $ref: '#/components/responses/success-bibs-holdings'
        '400':
          $ref: '#/components/responses/bib_holding_query_error'
        '405':
          $ref: '#/components/responses/method-not-supported'
        '406':
          $ref: '#/components/responses/failed-not-acceptable'
        '500':
          $ref: '#/components/responses/internal-server-error'
      security:
      - worldcat_search_auth:
        - wcapi:view_institution_holdings
  /worldcat/search/v2/bibs-detailed-holdings:
    get:
      tags:
      - Member General Holdings
      summary: Find detailed info of member holdings for a known item
      description: Given a known item, search member library holdings for detailed information
      operationId: find-bib-detailed-holdings
      parameters:
      - $ref: '#/components/parameters/accept'
      - $ref: '#/components/parameters/oclcNumber'
      - $ref: '#/components/parameters/isbn'
      - $ref: '#/components/parameters/issn'
      - $ref: '#/components/parameters/itemType'
      - $ref: '#/components/parameters/itemSubType'
      - $ref: '#/components/parameters/heldByGroup'
      - $ref: '#/components/parameters/heldBy'
      - $ref: '#/components/parameters/heldBySymbol'
      - $ref: '#/components/parameters/heldByInstitutionID'
      responses:
        '200':
          $ref: '#/components/responses/success-bibs-detailed-holdings'
        '400':
          $ref: '#/components/responses/bib_holding_query_error'
        '405':
          $ref: '#/components/responses/method-not-supported'
        '406':
          $ref: '#/components/responses/failed-not-acceptable'
        '500':
          $ref: '#/components/responses/internal-server-error'
      security:
      - worldcat_search_auth:
        - wcapi:view_holdings
components:
  parameters:
    heldByGroup:
      name: heldByGroup
      in: query
      description: Restrict to holdings held by Group Symbol
      required: false
      schema:
        type: string
      example: ASRL
    issn:
      name: issn
      in: query
      description: issn of the bibliographic item (in index)
      required: false
      schema:
        type: string
      example: 0099-1333
    heldBySymbol:
      name: heldBySymbol
      in: query
      description: Institution Symbol
      required: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/OCLCSymbol'
        minItems: 1
        maxItems: 5
      explode: false
      examples:
        single:
          value:
          - TXH
        multiple:
          value:
          - TXH
          - YSM
    numberNearestHoldings:
      name: numberNearestHoldings
      in: query
      description: When a lat/lon is passed, the number of nearest holdings to show even if outside the search radius.
      required: false
      schema:
        type: integer
        format: int32
        maximum: 200
      example: 20
    limit:
      name: limit
      in: query
      description: maximum number of records to return, maximum 50, default 10
      required: false
      schema:
        type: integer
        format: int32
        default: 10
      example: 50
    heldByInstitutionID:
      name: heldByInstitutionID
      in: query
      description: Institution registryId
      required: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/RegistryId'
        minItems: 0
        maxItems: 5
      explode: false
      examples:
        single:
          value:
          - 128807
        multiple:
          value:
          - 128807
          - 91475
    heldBy:
      name: heldBy
      in: query
      description: Institution Symbol
      deprecated: true
      required: false
      schema:
        type: string
      example: TXH
    unit:
      name: unit
      in: query
      description: distance unit
      required: false
      schema:
        $ref: '#/components/schemas/Unit'
    preferredLanguage:
      name: preferredLanguage
      in: query
      description: language user would prefer metadata description in
      required: false
      schema:
        description: three character MARC code for language to prefer records in
        type: string
        example: fre
    accept:
      name: Accept
      in: header
      description: Content Type the client supports and is requesting (application/json currently supported)
      schema:
        type: string
        default: application/json
      required: false
    lon:
      name: lon
      in: query
      description: longitude
      required: false
      schema:
        $ref: '#/components/schemas/Longitude'
    oclcNumber:
      name: oclcNumber
      in: query
      description: oclc number of the bibliographic item
      required: false
      schema:
        $ref: '#/components/schemas/OclcNumber'
      example: 41266045
    holdingsAllVariantRecords:
      name: holdingsAllVariantRecords
      in: query
      description: Get holdings for specific edition across variant records
      required: false
      schema:
        type: boolean
    holdingsFilterFormat:
      name: holdingsFilterFormat
      in: query
      description: Get holdings for specific itemSubType
      required: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/ItemSubType'
        minItems: 1
        maxItems: 5
      explode: false
      examples:
        single:
          value:
          - book-digital
        multiple:
          value:
          - book-digital
          - audiobook-digital
    offset:
      name: offset
      in: query
      description: start position of the bib records to return (0 based), default 0
      required: false
      schema:
        type: integer
        format: int32
        default: 0
      example: 10
    lat:
      name: lat
      in: query
      description: latitude
      required: false
      schema:
        $ref: '#/components/schemas/Latitude'
    heldInCountry:
      name: heldInCountry
      in: query
      description: Restrict to holdings held by institutions in requested country
      required: false
      schema:
        $ref: '#/components/schemas/Country'
      example: US
    itemSubType:
      name: itemSubType
      in: query
      description: Limiter to restrict the response to the single specified OCLC sub facet type (x1 index). (dvd, digital)
      required: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/ItemSubType'
        minItems: 1
        maxItems: 5
      explode: false
      examples:
        single:
          value:
          - book-digital
        multiple:
          value:
          - book-digital
          - audiobook-digital
    distance:
      name: distance
      in: query
      description: distance
      required: false
      schema:
        type: integer
        format: int32
      example: 10
    isbn:
      name: isbn
      in: query
      description: isbn of the bibliographic item (bn index)
      required: false
      schema:
        type: string
      example: 439136350
    heldInState:
      name: heldInState
      in: query
      description: Restrict to holdings held by Institutions in requested State/Province, per ISO 3166-2.
      required: false
      schema:
        $ref: '#/components/schemas/State'
      example: US-TX
    itemType:
      name: itemType
      in: query
      description: Limiter to restrict the response to the single specified OCLC top-level facet type (x0 index). (book, image)
      required: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/ItemType'
        minItems: 1
        maxItems: 5
      explode: false
      examples:
        single:
          value:
          - book
        multiple:
          value:
          - book
          - audiobook
    holdingsAllEditions:
      name: holdingsAllEditions
      in: query
      description: Get holdings for all editions
      required: false
      schema:
        type: boolean
    heldByLibraryType:
      name: heldByLibraryType
      in: query
      description: Filter holdings to specified library types
      required: false
      schema:
        type: array
        items:
          type: string
          enum:
          - PUBLIC
          - ALL
          default: ALL
        minItems: 1
        maxItems: 5
      explode: false
      examples:
        single:
          value:
          - PUBLIC
        multiple:
          value:
          - PUBLIC
          - ACADEMIC
  examples:
    success-bibs-detailed-holdings:
      summary: successful request for bibs and detailed holdings
      value:
        numberOfRecords: 1
        briefRecords:
        - oclcNumber: '318877925'
          title: Simon's cat / by Simon Tofield.
          creator: Simon. Tofield
          date: '2009.'
          language: eng
          generalFormat: Book
          specificFormat: PrintBook
          edition: 1st ed.
          publisher: Grand Central Pub.
          publicationPlace: 'New York :'
          mergedOclcNumbers:
          - '877908501'
          isbns:
          - '9780446560061'
          - '0446560065'
          catalogingInfo:
            catalogingAgency: DLC
            transcribingAgency: DLC
            catalogingLanguage: eng
            levelOfCataloging: ' '
          institutionHolding:
            totalHoldingCount: 227
            detailedHoldings:
            - lhrControlNumber: '238374600'
              lhrDateEntered: '20190617'
              lhrLastUpdated: '20190617'
              oclcNumber: '318877925'
              format: zu
              location:
                holdingLocation: OCPSB
                sublocationCollection: MAIN
                shelvingLocation: MAIN-STACKS
              copyNumber: '1'
              callNumber:
                displayCallNumber: prefix PN6738 .S56 test
                classificationPart: PN6738
                itemParts:
                - .S56
                prefixes:
                - prefix
                suffixes:
                - test
              hasSharedPrintCommitment: N
              holdingParts:
              - pieceDesignation: K123456789
            - lhrControlNumber: '250915410'
              lhrLastUpdated: '20180416'
              oclcNumber: '318877925'
              format: zu
              location:
                holdingLocation: OCPSB
                sublocationCollection: MAIN
                shelvingLocation: MAIN-STACKS
              copyNumber: '2'
              callNumber:
                displayCallNumber: PN6738 .S56
                classificationPart: PN6738
                itemParts:
                - .S56
              hasSharedPrintCommitment: N
              holdingParts:
              - pieceDesignation: '23798749734937'
    missing-query-parameter:
      summary: Error returned when required query parameter not sent
      value:
        type: MISSING_QUERY_PARAMETER
        title: Validation Failure
        detail: Required String parameter 'q' is not present
    missing-query-parameter-value:
      summary: Error returned when query parameter value not valid
      value:
        type: INVALID_QUERY_PARAMETER_VALUE
        title: Validation Failure
        detail: Query term is not provided.
    method-not-allowed-error:
      summary: Error when invalid HTTP method used
      value:
        title: NOT_ALLOWED
        detail: POST method not allowed
    not-acceptable-error:
      summary: Error when media type in Accept header not supported
      value:
        type: https://developer.api.oclc.org/errors/NOT_ACCEPTABLE
        title: ''
        detail: 'Media type application/xml not supported. Supported media types: application/json'
    success-bibs-holdings:
      summary: successful request for bibs and holdings
      value:
        numberOfRecords: 1
        briefRecords:
        - oclcNumber: '318877925'
          title: Simon's cat / by Simon Tofield.
          creator: Simon. Tofield
          date: '2009.'
          language: eng
          generalFormat: Book
          specificFormat: PrintBook
          edition: 1st ed.
          publisher: Grand Central Pub.
          publicationPlace: 'New York :'
          mergedOclcNumbers:
          - '877908501'
          isbns:
          - '9780446560061'
          - '0446560065'
          catalogingInfo:
            catalogingAgency: DLC
            transcribingAgency: DLC
            catalogingLanguage: eng
            levelOfCataloging: ' '
          institutionHolding:
            totalHoldingCount: 227
            totalEditions: 17
            briefHoldings:
            - country: US
              state: PA
              oclcSymbol: CPL
              registryId: 14692
              institutionName: Carnegie Library of Pittsburgh
              self: https://worldcat.org/oclc-config/institution/data/14692
              illStatus: S
              address:
                street1: 4400 Forbes Avenue
                city: Pittsburgh
                state: PA
                postalCode: '15213'
                country: US
                lat: '40.4428558'
                lon: '-79.9558487'
              institutionType: PUBLIC
            - country: US
              state: OH
              oclcSymbol: DMM
              registryId: 14235
              institutionName: Dayton Metro Library
              self: https://worldcat.org/oclc-config/institution/data/14235
              illStatus: S
              address:
                street1: 215 East Third Street
                city: Dayton
                state: OH
                postalCode: 45402-2103
                country: US
                lat: '39.7573013'
                lon: '-84.1862183'
              institutionType: PUBLIC
            - country: US
              state: OH
              oclcSymbol: LAP
              registryId: 14285
              institutionName: Lakewood Public Library
              self: https://worldcat.org/oclc-config/institution/data/14285
              illStatus: S
              address:
                street1: 15425 Detroit Ave
                city: Lakewood
                state: OH
                postalCode: 44107 2890
                country: US
                lat: '41.4814072'
                lon: '-81.7929535'
              institutionType: PUBLIC
            - country: US
              state: OH
              oclcSymbol: GRC
              registryId: 14415
              institutionName: Greene County Public Library
              self: https://worldcat.org/oclc-config/institution/data/14415
              illStatus: S
              address:
                street1: 76 East Market Street
                city: Xenia
                state: OH
                postalCode: 45385-0520
                country: US
                lat: '39.6839714'
                lon: '-83.9416656'
              institutionType: PUBLIC
    success-bibs-holdings-all-editions:
      summary: successful request for bibs and holdings
      value:
        numberOfRecords: 1
        briefRecords:
        - oclcNumber: '318877925'
          title: Simon's cat / by Simon Tofield.
          creator: Simon. Tofield
          date: '2009.'
          language: eng
          generalFormat: Book
          specificFormat: PrintBook
          edition: 1st ed.
          publisher: Grand Central Pub.
          publicationPlace: 'New York :'
          mergedOclcNumbers:
          - '877908501'
          isbns:
          - '9780446560061'
          - '0446560065'
          catalogingInfo:
            catalogingAgency: DLC
            transcribingAgency: DLC
            catalogingLanguage: eng
            levelOfCataloging: ' '
          institutionHolding:
            totalHoldingCount: 464
            totalEditions: 17
            briefHoldings:
            - country: US
              state: PA
              oclcSymbol: CPL
              registryId: 14692
              institutionName: Carnegie Library of Pittsburgh
              self: https://worldcat.org/oclc-config/institution/data/14692
              illStatus: S
              address:
                street1: 4400 Forbes Avenue
                city: Pittsburgh
                state: PA
                postalCode: '15213'
                country: US
                lat: '40.4428558'
                lon: '-79.9558487'
              institutionType: PUBLIC
            - country: US
              state: OH
              oclcSymbol: DMM
              registryId: 14235
              institutionName: Dayton Metro Library
              self: https://worldcat.org/oclc-config/institution/data/14235
              illStatus: S
              address:
                street1: 215 East Third Street
                city: Dayton
                state: OH
                postalCode: 45402-2103
                country: US
                lat: '39.7573013'
                lon: '-84.1862183'
              institutionType: PUBLIC
            - country: US
              state: OH
              oclcSymbol: LAP
              registryId: 14285
              institutionName: Lakewood Public Library
              self: https://worldcat.org/oclc-config/institution/data/14285
              illStatus: S
              address:
                street1: 15425 Detroit Ave
                city: Lakewood
                state: OH
                postalCode: 44107 2890
                country: US
                lat: '41.4814072'
                lon: '-81.7929535'
              institutionType: PUBLIC
            - country: US
              state: OH
              oclcSymbol: GRC
              registryId: 14415
              institutionName: Greene County Public Library
              self: https://worldcat.org/oclc-config/institution/data/14415
              illStatus: S
              address:
                street1: 76 East Market Street
                city: Xenia
                state: OH
                postalCode: 45385-0520
                country: US
                lat: '39.6839714'
                lon: '-83.9416656'
              institutionType: PUBLIC
    success-bibs-summary-holdings:
      summary: successful request for bibs and holdings
      value:
        numberOfRecords: 1
        briefRecords:
        - oclcNumber: '318877925'
          title: Simon's cat / by Simon Tofield.
          creator: Simon. Tofield
          date: '2009.'
          language: eng
          generalFormat: Book
          specificFormat: PrintBook
          edition: 1st ed.
          publisher: Grand Central Pub.
          publicationPlace: 'New York :'
          mergedOclcNumbers:
          - '877908501'
          isbns:
          - '9780446560061'
          - '0446560065'
          catalogingInfo:
            catalogingAgency: DLC
            transcribingAgency: DLC
            catalogingLanguage: eng
            levelOfCataloging: ' '
          institutionHolding:
            totalHoldingCount: 464
            totalSharedPrintCount: 0
            totalEditions: 17
    success-detailed-holdings-serial:
      summary: successful request for detailed holdings serials
      value:
        totalHoldingCount: 961
        detailedHoldings:
        - lhrControlNumber: '266349549'
          lhrDateEntered: '20190716'
          lhrLastUpdated: '20190716'
          oclcNumber: '2243594'
          format: zu
          location:
            holdingLocation: OCPSB
            sublocationCollection: MAIN
            shelvingLocation: MAIN-STACKS
          copyNumber: '1'
          callNumber:
            displayCallNumber: 020.5 O688465
            classificationPart: 20.5
            itemParts:
            - O688465
          hasSharedPrintCommitment: N
          holdingParts:
          - linkingAndSequenceNumber: '1.1'
            enumerations:
            - caption: v.
              value: '133'
            - caption: no.
              value: '1'
            chronologies:
            - caption: (year)
              value: '2008'
            - caption: (month)
              value: '01'
            - caption: (day)
              value: '01'
          - linkingAndSequenceNumber: '1.2'
            enumerations:
            - caption: v.
              value: '133'
            - caption: no.
              value: '2'
            chronologies:
            - caption: (year)
              value: '2008'
            - caption: (month)
              value: '01'
            - caption: (day)
              value: '02'
          - linkingAndSequenceNumber: '0'
            textualHoldings: v. 133 no. 1 - 2 (Jan - Apr 2008)
          - linkingAndSequenceNumber: '1.1'
            summaryOfHoldings: v.133:no.1(2008:Jan 1)
            pieceDesignation: testBarcode
            temporaryLocation: MAIN-Reference
          - linkingAndSequenceNumber: '1.2'
            summaryOfHoldings: v.133:no.2(2008:Jan 2)
            pieceDesignation: testBarcode2
    invalid-oclc-number:
      summary: Error returned when oclc number isn't valid
      value:
        type: INVALID_QUERY_PARAMETER_VALUE
        title: Validation Failure
        detail: oclcNumber must be a positive whole number
    not-acceptable-error-language:
      summary: Error when language in Accept-Language header not supported
      value:
        type: https://developer.api.oclc.org/errors/NOT_ACCEPTABLE
        title: ''
        detail: 'en-UK supported. Supported languages: en, es, fr'
  schemas:
    HoldingDetail:
      type: object
      properties:
        lhrControlNumber:
          description: LHR Control Number [LHR -> HldDetRec/c001]
          type: string
        lhrDateEntered:
          description: LHR Date Entered [LHR -> HldDetRec/Admin/CreateDate]
          type: string
        lhrLastUpdated:
          description: LHR Date Last Used [LHR -> HldDetRec/Admin/ReplacedDate]
          type: string
        oclcNumber:
          description: OCLC Number [LHR -> HldDetRec/c004]
          type: string
        format:
          description: material format [LHR -> HldDetRec/c007]
          type: string
        location:
          $ref: '#/components/schemas/HoldingLocation'
        copyNumber:
          description: copy number [LHR -> HldDetRec/v852st]
          type: string
        callNumber:
          $ref: '#/components/schemas/CallNumber'
        lendingPolicy:
          description: local lending policy [LHR -> HldDetRec/Admin/Lend]
          type: string
        hasSharedPrintCommitment:
          $ref: '#/components/schemas/HasSharedPrintCommitment'
        sharedPrintCommitments:
          description: shared print details [LHR -> HldDetRec/v583]
          type: array
          items:
            $ref: '#/components/schemas/SharedPrintCommitment'
        summary:
          description: summary statement [LHR -> HldSummRec/v966sa]
          type: string
        holdingParts:
          description: Textual Holding [LHR -> HldDetRec/v866,v867,v868] Item Information Holding [LHR -> HldDetRec/v876,v877,v878] Enumeration Chronology Holding [LHR -> HldDetRec/v863,v864,v865]
          type: array
          items:
            $ref: '#/components/schemas/HoldingPart'
      required:
      - lhrControlNumber
      - lhrDateEntered
      - lhrLastUpdated
      - oclcNumber
      - format
      - lendingPolicy
      - hasSharedPrintCommitment
    GeneralFormat:
      description: General Format Type [Admin/OCLCDef/StdRT]
      type: string
      enum:
      - Archv
      - ArtChapter
      - AudioBook
      - Book
      - CompFile
      - Encyc
      - Game
      - Image
      - IntMM
      - Jrnl
      - Kit
      - Map
      - MsScr
      - Music
      - News
      - Object
      - Snd
      - Toy
      - Video
      - Vis
      - Web
    SubFacetValue:
      type: object
      properties:
        value:
          type: string
        count:
          type: integer
          format: int32
    CatalogingLanguage:
      description: Language record was cataloged in [v040sb]
      type: string
    RegistryId:
      description: The identifier in the WorldCat Registry for the institution
      type: integer
    HoldingLocation:
      description: Local holding location [LHR -> v852sa,b,c]
      type: object
      properties:
        holdingLocation:
          description: Institution Symbol [LHR -> v852sa]
          type: string
        sublocationCollection:
          $ref: '#/components/schemas/SublocationCollection'
        shelvingLocation:
          $ref: '#/components/schemas/ShelvingLocation'
    SharedPrintCommitment:
      type: object
      properties:
        actionNote:
          description: Action Note [LHR -> HldDetRec/v583sa]
          type: string
        materialsSpecified:
          description: Materials Sepcified [LHR -> HldDetRec/v583s3]
          type: string
        institution:
          description: Institution to which applies [LHR -> HldDetRec/v583s5]
          type: string
        dateOfAction:
          description: date of action [LHR -> HldDetRec/v583sc]
          type: string
        commitmentExpirationDate:
          description: commitment expiration date [LHR -> HldDetRec/v583sd]
          type: string
        authorization:
          description: Authorization [LHR -> HldDetRec/v583sf]
          type: string
        methodOfAction:
          description: Method of Action [LHR -> HldDetRec/v583si]
          type: string
        siteOfAction:
          description: Site of Action [LHR -> HldDetRec/v583sj]
          type: string
        status:
          description: Status [LHR -> HldDetRec/v583sl]
          type: string
        uri:
          description: URI [LHR -> HldDetRec/v583su]
          type: string
        publicNote:
          description: Public Note [LHR -> HldDetRec/v583sz]
          type: string
    ItemType:
      description: Filter values for General Format
      type: string
      enum:
      - archv
      - artchapter
      - audiobook
      - book
      - compfile
      - encyc
      - game
      - image
      - intmm
      - jrnl
      - kit
      - map
      - msscr
      - music
      - news
      - object
      - snd
      - toy
      - video
      - vis
      - web
    HoldingBrief:
      type: object
      properties:
        country:
          description: Country of holding institution [Holdings/Library/Country]
          type: string
        state:
          description: State of holding institution [Holdings/Library/State]
          type: string
        oclcSymbol:
          description: Oclc Symbol of holding institution [Holdings/Library/InstSym]
          type: string
        registryId:
          $ref: '#/components/schemas/RegistryId'
        institutionName:
          description: Name of holding institution [Holdings/Library/InstName]
          type: string
        alsoCalled:
          description: Some name the library might also be called
          type: string
        address:
          $ref: '#/components/schemas/Address'
        institutionType:
          $ref: '#/components/schemas/InstitutionType'
        hasOPACLink:
          description: Whether or not the library has an OPAC deep links
          type: boolean
        distance:
          description: Distance from location if lat/log was specified
          type: string
        self:
          description: URI to find more info about the institution
          type: string
          format: uri
        illStatus:
          description: ILL status [Holdings/Library/ILLStatus]
          type: string
        illGroup:
          description: ILL group [Holdings/Library/ILLGroup]
          type: string
        hasSharedPrintCommitment:
          description: institution has shared print commitment [Holdings/LibHasSharedPrint]
          type: string
          enum:
          - Y
          - N
    InstitutionHolding:
      type: object
      properties:
        totalHoldingCount:
          description: Number of holdings for this item [Holdings/TotalLibCount || FRBRHoldings/B]
          type: integer
          format: int32
        totalWorksHoldingCount:
          description: Number of holdings in the workset [FRBRHoldings/B]
          type: integer
          format: int32
        totalEditions:
          $ref: '#/components/schemas/TotalEditions'
      oneOf:
      - $ref: '#/components/schemas/briefHoldings'
      - $ref: '#/components/schemas/detailedHoldings'
    Address:
      type: object
      properties:
        street1:
          description: Name of street
          type: string
        street2:
          description: Name of street 2
          type: string
        city:
          description: Name of city
          type: string
        state:
          $ref: '#/components/schemas/State'
        postalCode:
          $ref: '#/components/schemas/PostalCode'
        country:
          $ref: '#/components/schemas/Country'
        lat:
          $ref: '#/components/schemas/Latitude'
        lon:
          $ref: '#/components/schemas/Longitude'
    SubFacet:
      type: object
      properties:
        index:
          type: string
        facetType:
          type: string
        values:
          type: array
          items:
            $ref: '#/components/schemas/SubFacetValue'
    TextualHoldingsStatement:
      description: '[866-8 |a]'
      type: string
 

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/worldcat/refs/heads/main/openapi/worldcat-member-general-holdings-api-openapi.yml