Services and Operations > Reserve service > lookupReservePaging

lookupReservePaging

The lookupReservePaging operation allows you to page through a lookupReserve results list (hitlist) using a specified beginning and ending range within the specified number of found results.

Synopsis

Service

Reserve service

Namespace

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

Prerequisites

Valid clientID (see clientID)

Request

LookupReservePagingRequest

Response

LookupReservePagingResponse

Operation faults

IllegalArgumentException

(See also Faults)

LookupReservePagingRequest

The LookupReservePagingRequest 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

browseDirection

BrowseDirection

Specifies the direction to use for retrieving the next set of paged results.

Y

Specify either firstEntryLineNum or lastEntryLineNum

firstEntryLineNum

xs:int

Specifies the entry number for the first record returned by the previous lookup request.

Only required if browseDirection is BACKWARD.

Y

lastEntryLineNum

xs:int

Specifies the entry number for the last record returned by the previous lookup request.

Only required if browseDirection is FORWARD.

reserveDesk

xs:string

Specifies the reserve desk value.

If no value is specified, the default is ALL.

N

Specify either userPrimaryKey or userID

userPrimaryKey

xs:long

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

Y

userID

xs:string

Specifies the ID 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

listID

xs:int

Specifies the unique ID of the results.

This allows you to page through the lookupReserve results list.

This value is returned with the LookupReservePagingResponse (whether from the LookupReserveRequest or LookupReservePagingRequest).

Y

LookupReservePagingResponse

The LookupReservePagingRequest returns the following elements.

Element

Type

Occ.

Description

reserveDesk

xs:string

1

Displays the reserve desk value.

userID

xs:string

0..1

Displays the ID of the instructor.

userDisplayName

xs:string

0..1

Displays the instructor's name.

userDepartment

RequestEntryInfo

0..1

Displays the department of the instructor associated with this reserve.

courseID

xs:string

0..1

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

reserveInfo

ReserveInfo

0..*

Displays ReserveInfo information.

totalHits

xs:int

0..1

Displays the total number results matching the request.

firstEntryLineNum

xs:int

1

Displays the entry number for the first record returned by the lookup request.

lastEntryLineNum

xs:int

1

Displays the entry number for the last record returned by the lookup request.

forwardAvailable

xs:boolean

1

Displays whether more results are available for a FORWARD browseType.

backwardAvailable

xs:boolean

1

Displays whether more results are available for a BACKWARD browseType.

listID

xs:int

1

Displays the unique ID of the results.

Related topics 

 


© 2009-2012 SirsiDynix