The Volume API

The Volume API contains methods for retrieving volume records (the .j record type). Volume records contain information about multi-volume titles and the associated bibliographic and item records. The information returned by the endpoints below can help patrons select a volume when placing a volume-level hold. For more information on volume records, see Record Types in the Sierra WebHelp.

Using this API, you can:

The Try it out! links below take you to the corresponding section in the interactive documentation, where you can view the model, model schema, and parameters for each available operation.

Get a List of Volume Records

This endpoint is available in Sierra 5.2 and later. To use this endpoint, your key must be assigned the Volumes Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/volumes/

Returns the properties of the first x Volume Objects, where x = the value specified in the limit parameter. If you do not enter a limit, the system returns 50 records by default.

You can specify a list or a range of records IDs to retrieve specific records. Additionally, you can specify certain record properties to return only records that contain the corresponding data. See Search Parameters for more information.

You can also specify which fields in the volume record to return.

By default, queries do not return all data for the volume record; you must specify additional properties using filter parameters. For example, to retrieve variable-length field information, specify "varFields" in the fields parameter. See Filter Parameters for more information.

If you do not specify filter parameters, queries return the following volume record information by default:

  • volume record ID
  • the date and time of the last update to the record
  • the date and time the record was created
  • whether the record has been deleted
  • the date the record was deleted (appears only if the record has been deleted)
  • the volume number or volume title
  • links to the bibliographic records associated with this volume
  • links to the item records associated with this volume

Try it out!

Get a Volume Record by Record ID

This endpoint is available in Sierra 5.2 and later. To use this endpoint, your key must be assigned the Volumes Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/volumes/{id}

Returns a single Volume Object with the specified record ID.

By default, queries do not return all data for the volume record; you must specify additional properties using filter parameters. For example, to retrieve variable-length field information, specify "varFields" in the fields parameter. See Filter Parameters for more information.

If you do not specify filter parameters, queries return the following volume record information by default:

  • volume record ID
  • the date and time of the last update to the record
  • the date and time the record was created
  • whether the record has been deleted
  • the date the record was deleted (appears only if the record has been deleted)
  • the volume number or volume title
  • links to the bibliographic records associated with this volume
  • links to the item records associated with this volume

Try it out!