Ready to Learn?Ex Libris products all provide open APIs

ISO 20775 Schema for holdings

The ISO 20775 standard specifies a schema isohold designed to cover the holdings of all types of resources, physical, electronic and digital. It is mainly intended for resource sharing purposes but can be used for retrieval of inventory information for any use. The new schema adds the "holdings" tag under the SRU recordData in the generic response.

The SRU ISO 20775 standard is based on the XSD.

Usage

In order to use the new schema as part of SRU/SRW Search the SRU Server integration profile must be configured. For more information please refer to the OLH.

For example: https://Alma domain/view/sru/institution_code?version=1.2&operation=searchRetrieve&recordSchema=isohold&query=alma.all_for_ui=history

Query on campus level 

The new isohold schema can be used to query item availability and holdings information on campus level. This means that the data filtering can be either on the institution level (as the current SRU operates) or on the campus level. The new parameter for filtering on campus level ‘x-filterHoldingsByCampusCode’ will be used on the SRU request with the campus name to be filter on.

For exmaple: https://<Alma domain>/view/sru/<institution code>?version=1.2&operation=searchRetrieve&recordSchema=isohold&query=alma.title=<title>&x-filterHoldingsByCampusCode=<campus>

Response structure

See ISO 20775 response from Alma's Guest sandbox

XML Tag 
Description
Returned Value

holdings

A bibliographic resource or group of like or similar resources and one or more institution’s copies of the resource or resources

 

holding

Group of data elements describing one institution’s copies of a bibliographic resource or group of like or similar bibliographic resources

Repeatable tag – one per holding/portfolio/representation

institutionIdentifier

Group of data elements serving as a brief identifier of an institution

 

value

Identifier or identifying code

<ISIL code> (library/institution)

typeOrSource

Code, phrase or pointer indicating a source within which a value is unique

 

text

Phrase indicating a definitive list of values within which an identifier or code is unique

ISIL

physicalLocation

Name of an institution holding one of more copies of a bibliographic resource

<library name> *

holdingSimple

Information for a resource or group of resources summarizing number of copies, and the number actually available

Repeatable per monograph

copiesSummary

Group of data elements summarizing the number of copies of a bibliographic resource or resources and their availability

 

copiesCount

Count of the number of physical or digital copies associated with a resource.  If unknown set to 1

<number of copies>

 status

Group of data elements indicating and predicting actual availability of a group of copies

Repeatable per availableFor type

availableCount

Count of the number of physical or digital copies of a resource that are available for use or delivery in the context of a particular request

Based on the configuration on the integration profile: <number of copies available for use or delivery>

availableFor

Code indicating the nature of service available in relation to a specific bibliographic resource

  • 1 (loan)
  • 2 (physical copy)
  • 3 (digital copy)
  • 4 (online access )

[3 and 4 for electronic/digital]

earliestDispatchDate

Date and time on which a resource or any copy of a resource will be ready for delivery

<availability date for ILL> [YYYY-MM-DD]

copyInformation

Group of data elements providing details of a specific copy of physical or digital resource

Repeatable tag – one per item/portfolio/representation

pieceIdentifier

Group of data elements that identify a specific instance of a resource

 

value

Identifier or identifying code

  • <barcode> *
  • <portfolio_id> **
  • <representation_id> ***

typeOrSource

Code, phrase or pointer indicating a source within which a value is unique

 

text

Phrase indicating a definitive list of values within which an identifier or code is unique

  • ITEM ID” *
  • PORTFOLIO ID” **
  • REPRESENTATION ID” ***

resourceIdentifier

Group of data elements identifying a bibliographic resource or its associated metadata record with an indication of a list or source list within which the identifier is unique

 

value

 

  • <holding_mms_id> *
  • <collection_id> **

typeOrSource

Code, phrase or pointer indicating a source within which a value is unique

 

text

Phrase indicating a definitive list of values within which an identifier or code is unique

  • HOLDING MMS ID” *
  • COLLECTION ID” **

 

sublocation

Name or code of a section and / or collection of a library or other institution that normally stores a copy or set when it is not in use, on loan or on the reservation shelves. Repeatable in the case of electronic copies that may be accessible from more than one location

  • <item current location> *
  • <available for campus/library> **
  • <available for institution> ***

[Institute:<inst_code_1>,<inst_code_2>,…;

Campus:<camp_code_1>,<camp_code_2>…;

Library:<lib_code_1>,<lib_code_2…>]

shelfLocator

String of characters that identifies a copy’s or a set's shelving scheme within a sublocation in relation to other copies.  Repeated in the case where runs are stored at different locations

<item call number> *

note

Phrase relating to a copy of a bibliographic resource, carrying additional information

<item/portfolio/representation public note>

availabilityInformation

Group of data elements summarizing the availability of a particular physical or digital copy of a resource.

 

status

Group of data elements indicating and predicting actual availability of a copy or group of copies

Repeatable per availableFor type

availabilityStatus

Code that indicates the availability for loan or access of a copy or group of copies in the context of a particular request

Based on the configuration on the integration profile:

  • 1 (available)
  • 2 (not available)

availableFor

Code indicating the nature of service available in relation to a specific bibliographic resource

  • 1 (loan)
  • 2 (physical copy)
  • 3 (digital copy)
  • 4 (online access)

[3 and 4 for electronic/digital]

dateTimeAvailable

Date and time on which a resource or a particular copy of a resource will be ready for delivery or access

<earliest date item is ready for delivery> (for electronic/digital) [YYYY-MM-DD]

policy

Phrase or structure indicating restrictions which apply in relation to loan, copy or access.  Examples:  not for loan, in library use only, overnight only... Recommended structure from ISO 2146

  • <item policy> *
  • <service type> **

 

holdingStructured

Group of data elements providing descriptive information and an indication of the coverage, completeness, availability and service policy of a bibliographic resource that is published serially or in multiple parts

Repeatable per serial or inventory with no items 

set

Collection of components of a bibliographic resource including multi-volume publications and resources published serially, often received by a subscription purchases

 

label

Number or phrase serving to identify a set of copies such as a subscription for a resource that is published in multiple parts or serially.  "All sets" is a reserved label indicating a consolidated summary for all sets

All sets

sublocation

Name or code of a section and / or collection of a library or other institution that normally stores a copy or set when it is not in use, on loan or on the reservation shelves. Repeatable in the case of electronic copies that may be accessible from more than one location

  • <holding location> *
  • <available for campus/library> **
  • <available for institution> ***

shelfLocator

String of characters that identifies a copy’s or a set's shelving scheme within a sublocation in relation to other copies.  Repeated in the case where runs are stored at different locations

<holding call number> *

completeness

Code indicating the level of holdings of a copy set ranging from complete to signaling gaps or substantial gaps

Code indicating the level of holdings of a copy set ranging from complete to signaling gaps or substantial gaps:

  • 0 (info not available)
  • 2 (incomplete)

enumerationAndChronology

Text string or group of data elements identifying a unit of a resource that is published in parts.  Repeatable in the case of multiple numbering ranges (gaps) and multiple numbering sequences

Repeatable per summary holdings

(limited for 100 items)

Not relevant for digital

  startingEnumAndChronology

Group of data elements indicating the beginning of an enumeration and chronology range

 

text

 

  • <summary holdings> *
  • <coverage information> **

 

component

Unique bibliographic part of a set, such as a volume of a serial or multi-volume work

Repeatable tag – one per item

pieceIdentifier

Group of data elements that identify a specific instance of a resource

 

value

Identifier or identifying code

  • <barcode> *
  • <portfolio_id> **
  • <representation_id> ***

typeOrSource

Code, phrase or pointer indicating a source within which a value is unique

 

text

Phrase indicating a definitive list of values within which an identifier or code is unique

SUFFICIENT

sublocation

Name or code of a section and / or collection of a library or other institution that normally stores a copy or set when it is not in use, on loan or on the reservation shelves. Repeatable in the case of electronic copies that may be accessible from more than one location

<item current location>

shelfLocator

String of characters that identifies a copy’s or a set's shelving scheme within its sublocation in relation to other copies.  Rarely repeated except in the case of parts being at different locations, e.g. inserted CD within a book

<item call number (permanent or temporary)>

note

Phrase relating to a copy of a bibliographic resource, carrying additional information

<item/portfolio/representation public note>

     enumerationAndChronology

Text string or group of data elements alphabetically identifying a unit of a resource that is published in parts.  Repeatable in the case of multiple numbering sequences

 

text

 

  • <item description> *
  • <coverage information> **
  • <label> ***

availabilityInformation

Group of data elements summarizing the availability of a particular physical or digital copy of a resource.

 

status

Group of data elements indicating and predicting actual availability of a copy or group of copies

Repeatable tag per availableFor type

availabilityStatus

Code that indicates the availability for loan or access of a copy or group of copies in the context of a particular request

Based on the configuration on the integration profile:

  • 1 (available)
  • 2 (not available)

availableFor

 

  • 1 (loan)
  • 2 (physical copy)
  • 3 (digital copy)
  • 4 (online access)

dateTimeAvailable

Date and time on which a resource or a particular copy of a resource will be ready for delivery or access

<date> [YYYY-MM-DD]

resource

Group of data elements identifying and describing one or more works, created by intellectual effort that may be expressed in physical or digital form.

If more than one resource is present then the holdings relate to any one of those resources: the resources are treated as interchangeable

One per record (except for Serial holding)

resourceIdentifier

Group of data elements identifying a bibliographic resource or its associated metadata record with an indication of a list or source list within which the identifier is unique

 

value

 

<bib_mms_id>

typeOrSource

 

 

text

 

  • SUFFICIENT” – response contains sufficient information to make an ILL request
  • INSUFFICIENT” – response contains insufficient information to make an ILL request
* for print
** for electronic
*** for digital