Services and Operations > Reserve service > listReserve

listReserve

The listReserve operation allows you to find instructors or courses that have associated reserve records and that match the given browse type and search criteria.

Synopsis

Service

Reserve service

Namespace

http://schemas.sirsidynix.com/symws/reserve

Prerequisites

Valid clientID (see clientID)

Request

ListReserveRequest

Response

ListReservePagingResponse

Operation faults

IllegalArgumentException

(See also Faults)

ListReserveRequest

The ListReserveRequest has the following request parameters:

Parameter

Type

Description

Required?

hitsToDisplay

xs:int

Specifies the maximum number of results to return for the request.

If no value is specified, the default is 20.

N

reserveDesk

xs:string

Specifies the reserve desk value.

If no value is specified, the default is ALL.

N

browseType

BrowseType

Specifies the search type to use for the request.

For example, you can search by course name.

Y

Specify either userPrimaryKey or userID for browseType of USER_NAME

userPrimaryKey

xs:long

Specifies the database key of the instructor's user record.

Y (if browseType is USER_NAME)

userID

xs:string

Specifies the ID or name of the instructor.

The ID is typically a barcode, but depending on the ILS configuration, could be any string.

courseID

xs:string

Specifies the ID of the course associated with the instructor and the reserve item.

Y (if browseType is COURSE_ID or COURSE_NAME)

ListReservePagingResponse

The ListReserveRequest returns the ListReservePagingResponse.

Related topics 

 


© 2009-2012 SirsiDynix