Services and Operations > Reserve service > listReservePaging

listReservePaging

The listReservePaging operation allows you to page through a listReserve 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

listReservePaging

Response

listReservePaging

Operation faults

IllegalArgumentException

(See also Faults)

ListReservePagingRequest

The ListReservePagingRequest 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 searching type to use for the request.

For example, you can search by course name.

Y

browseDirection

BrowseDirection

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

Y

Specify either firstLineNum or lastLineNum

firstLineNumber

xs:int

Specifies the entry line number for the first record returned by the previous list request. Only required if browseDirection is BACKWARD.

Y

lastLineNumber

xs:int

Specifies the entry line number for the last record returned by the previous list request. Only required if browseDirection is FORWARD.

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

Specify either userPrimaryKey or userID if the browseType is 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.

listID

xs:int

Specifies the unique ID of the results.

This allows you to page through the listReserve results list.

This value is returned with the ListReservePagingResponse (whether from the ListReserveRequest or ListReservePagingRequest).

Y

ListReservePagingResponse

The ListReservePagingRequest returns the following elements.

Element

Type

Occ.

Description

browseType

BrowseType

1

Displays the type of browse used for the request.

reserveDesk

xs:string

1

Displays the reserve desk value.

userID

xs:string

0..1

Displays the ID of the instructor.

This element is only returned here if the browseType is USER_NAME.

userName

xs:string

0..1

Displays the instructor's name.

This element is only returned here if the browseType is USER_NAME.

userDepartment

RequestEntryInfo

0..1

Displays the department of the instructor associated with this reserve.

This element is only returned here if the browseType is USER_NAME.

courseID

xs:string

0..1

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

This element is only returned here if the browseType is COURSE_ID or COURSE_NAME.

courseName

xs:string

0..1

Displays the name of the course associated with this reserve.

This element is only returned here if the browseType is COURSE_ID or COURSE_NAME.

reserveInfo

ReserveInfo

0..*

Displays ReserveInfo information.

totalHits

xs:int

1

Displays the total number results matching the request.

firstLineNumber

xs:int

1

Displays the entry line number for the first record returned by the list request.

lastLineNumber

xs:int

1

Displays the entry line number for the last record returned by the list 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