Volume Object

Click the links below to view the Volume Object properties and examples. See the Volume API for more information.

id

string

(Always returned in the response.)

The unique volume record ID.

Example: 

"id": "1000057"

updatedDate

string

The date and time of the last update to the record, in ISO 8601 format. (YYYY-MM-DD'T'hh:mm:ssZZ). The system updates this field any time the record is edited.

Example: 

"updatedDate": "2013-12-11T19:20:28Z"

createdDate

string

The date and time the record was created, in ISO 8601 format. (YYYY-MM-DD'T'hh:mm:ssZZ). The createdDate property can be used to search for a volume by its creation date.

Example: 

"createdDate": "2013-12-11T19:04:44Z"

deletedDate

string

(Appears only if the record has been deleted.)

The date the record was deleted, in ISO 8601 format (YYYY-MM-DD).

Example: 

"deletedDate": "2014-01-11"

deleted

boolean

Specifies whether the record has been deleted.

Deleted Records

Deleted records return only their id, deletedDate, and deleted properties.

Example: 

"deleted": true

holds

array

A list of strings, which are links to hold IDs for the volume.

Example: 

"holds": [
"https://example-library.edu/iii/sierra-api/v6/patrons/holds/3905"
]

volume

string

The volume number or volume title.

Example: 

"volume": "Season 1"

bibs

array

A link to the bibliographic record associated with this volume.

Example: 

"bibs": [
  "https://example-library.edu/iii/sierra-api/v6/bibs/1076231"
]

items

string

A list of strings, which are the links to the item records associated with this volume.

Example: 

"items": "https://example-library.edu/iii/sierra-api/v6/bibs/1582896"

varFields

array

(Returned only if requested.)

The varFields property contains a list of VarField objects, which contain variable-length data fields from the volume record.

Example:

See varFields Array.

The preceding list order reflects the sequence in which the data returns.

The following example sends a call to GET /v6/volumes/{id} to return a volume using a supplied volume ID.

In the call below, the volume ID is highlighted in red. In the response, the ID is highlighted in bold.

Example response for:

https://example-library.edu:443/iii/sierra-api/v6/volumes/1000003fields=default,varFields
{
     "id": 1000003,
     "updatedDate": "2021-06-23T21:42:11Z",
     "createdDate": "2019-10-01T21:45:09Z",
     "deleted": false,
     "volume": "Season 1",
     "bibs": [
         "https://example-library.edu:443/iii/sierra-api/v6/bibs/1468742"
     ],
     "items": [
         "https://example-library.edu:443/iii/sierra-api/v6/items/1582896"
     ],
     "varFields": [
         {
         "fieldTag": "v",
         "content": "Season 1"
         }
     ]
}