Data types reference > Web Services data types > Reserve service > ReserveInfo

ReserveInfo

The ReserveInfo type displays specific details about the reserves.

Ancestors

None

Relevant operations

browseReserve
browseReservePaging
listReserve
listReservePaging
lookupReserve
lookupReservePaging

Contents

This type has the following elements. Some elements are only returned for certain operations (and some are only returned when the operation has a certain browseType). If no operation is listed in the table, then the element is always returned.

Operation

Element

Type

Occ.

Description

 

entryNum

xs:long

1

Displays the entry number for the reserve.

 

uniqueID

xs:string

1

Displays a unique identifier for the reserve.

lookupReservePaging

reserveControlUniqueKey

xs:int

0..1

Displays the unique key of the reserve.

lookupReservePaging

reserveNumber

xs:int

0..1

Displays the reserve number.

lookupReservePaging

reserveCopies

xs:int

0..1

Displays the number of copies held in reserve.

lookupReservePaging

numberOfHolds

xs:int

0..1

Displays the number of holds for the reserve.

 

circulationRuleID

xs:string

0..1

Displays the ID of the circulation rule associated with this reserve.

 

reserveBookingPolicyID

xs:string

0..1

Displays the reserve booking policy ID.

lookupReservePaging

catalogKey

xs:long

0..1

Displays the catalog key for the item in reserve.

lookupReservePaging

itemID

xs:string

0..1

Displays the item ID for the item in reserve.

lookupReservePaging

callNumber

xs:string

0..1

Displays the call number for the item in reserve.

lookupReservePaging

displayableCallNumber

xs:string

0..1

Displays the displayable call number for the item in reserve.

lookupReservePaging

author

xs:string

0..1

Displays the name of the author of the item held in reserve.

lookupReservePaging

title

xs:string

0..1

Displays the title of the item held in reserve.

 

dueDate

xs:date

0..1

Displays the due date for the reserve.

browseReserve
browseReservePaging

numReservesForCourse

xs:int

0..1

Displays the number of items in reserve for the course.

browseReserve (when browseType is COURSE_ID or COURSE_NAME)
browseReservePaging (when browseType is COURSE_ID or COURSE_NAME)
listReserve (when browseType is USER_NAME)
listReservePaging (when browseType is USER_NAME) lookupReserve

courseID

xs:string

0..1

Displays the ID of the course associated with this reserve item.

browseReserve (when browseType is COURSE_ID or COURSE_NAME)
browseReservePaging (when browseType is COURSE_ID or COURSE_NAME)
listReserve (when browseType is USER_NAME)
listReservePaging (when browseType is USER_NAME) lookupReserve

courseName

xs:string

0..1

Displays the name of the course associated with this reserve item.

 

courseTermID

xs:string

0..1

Displays the ID of the term for the course associated with this reserve item.

browseReserve (when browseType is USER_NAME)
browseReservePaging (when browseType is USER_NAME)
listReserve (when browseType is COURSE_ID or COURSE_NAME)
listReservePaging (when browseType is COURSE_ID or COURSE_NAME)

userID

xs:string

0..1

Displays the ID of the instructor associated with this reserve.

browseReserve (when browseType is USER_NAME)
browseReservePaging (when browseType is USER_NAME)
listReserve (when browseType is COURSE_ID or COURSE_NAME)
listReservePaging (when browseType is COURSE_ID or COURSE_NAME)

userPrimaryKey

xs:long

0..1

Displays the database key of the instructor's user record that is associated with this reserve item.

browseReserve (when browseType is USER_NAME)
browseReservePaging (when browseType is USER_NAME)
listReserve (when browseType is COURSE_ID or COURSE_NAME)
listReservePaging (when browseType is COURSE_ID or COURSE_NAME)

userDisplayName

xs:string

0..1

Displays the displayable name of the instructor associated with this reserve item.

 


© 2009-2012 SirsiDynix