Hold Object

Click the links below to view the Hold Object properties and an example.

Hold Object Properties

string

(Always returned in the response.)

The ID of the hold, returned as an API endpoint.

Example:

"id": "https://example-library.edu/iii/sierra-api/v6/patrons/holds/406333"

record

string

The bib, item, or volume record number associated with the hold, returned as an API endpoint.

The endpoint returned for volume holds is not a valid API endpoint. It is returned for volume record ID information only.

Example:

"record": "https://example-library.iii.com/iii/sierra-api/v6/bibs/2311644"

patron

string

The patron record number associated with the hold, returned as an API endpoint.

Example:

"patron": "https://example-library.iii.com/iii/sierra-api/v6/patrons/1042514"

frozen

boolean

Whether the record is frozen.

Example:

"frozen": false

placed

string

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

Example:

"placed": "2021-04-28"

notNeededAfterDate

string

The date the hold expires, in ISO 8601 format (YYYY-MM-DD).

Example:

"notNeededAfterDate": "2021-08-31"

notWantedBeforeDate

string

The date before which the system should not fill the hold, in ISO 8601 format (YYYY-MM-DD).

Example:

"notWantedBeforeDate": "2021-04-28"

location

object

The location property contains a Location object, which contains the branch location (code and display name) from which to fill the hold, if the hold is set for "Limit to Location" (does not apply to item-level holds).

Example:

"location": {
    "code": "12",
    "name": "Edenvale"
}

Child Properties

code

string

The location code.

Example:

"code": "12"

name

string

The location display name.

Example:

"name": "Edenvale"

pickupByDate

string

The date the hold must be picked up by the patron, in ISO 8601 format (YYYY-MM-DD).

Example:

"pickupByDate": "2022-01-01T00:00:00Z"

pickupLocation

object

The pickupLocation property contains a Location object, which contains the branch location code and display name of the hold's pickup location.

Example:

"location": {
    "code": "21",
    "name": "Vineland"
}

Child Properties

code

string

The location code.

Example:

"code": "21"

name

string

The location display name.

Example:

"name": "Vineland"

status

object

The status property contains a HoldStatus object, which contains the status code and description.

0 On hold.

b Bib hold ready for pickup.

j Volume hold ready for pickup.

i Item hold ready for pickup.

t Bib, item, or volume in transit to pickup location.

Example:

"status": {
  "code": "0",
  "name": "On hold."
}

Child Properties

code

string

The status code.

Example:

"code": "0"

name

string

The status display name.

Example:

"name": "On hold."

recordType

string

A record type code, i.e., bib (b), item (i), or volume (j).

Example:

"recordType": "b"

priority

integer

The priority (place in line) of the hold.

Example:

"priority": 1

priorityQueueLength

integer

The length of the hold queue.

Example:

"priorityQueueLength": "7"

note

string

An informational note related to the hold.

Example:

"note": "Please call me when this item arrives."

canFreeze

boolean

Specifies whether the hold can be frozen.

Example:

"canFreeze": "false"

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

Default Response Contents

Default query responses for the Hold object include all available properties.