Services and Operations > Reserve service > browseReservePaging

browseReservePaging

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

BrowseReservePagingRequest

Response

BrowseReservePagingResponse

Operation faults

IllegalArgumentException
NullPointerException - returned if the required entryValue or entryID is not correct (it needs to be the value returned in the previous BrowseReservePagingResponse (from either browseReserve or browseReservePaging).

(See also Faults)

BrowseReservePagingRequest

The BrowseReservePagingRequest has the following request parameters:

Parameter

Type

Description

Required?

browseDirection

BrowseDirection

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

Y

browseType

BrowseType

Specifies the type of browse to use for the request. For example, you can browse by course name.

Y

Specify either firstEntryID or lastEntryID

firstEntryID

xs:long

Specifies the entry ID for the first record returned by the previous browse request. Only required if browseDirection is BACKWARD.

Y

lastEntryID

xs:long

Specifies the entry ID for the last record returned by the previous browse request. Only required if browseDirection is FORWARD.

Specify either firstEntryValue or lastEntryValue

firstEntryValue

xs:string

Specifies the value for the first record returned by the previous browse request. Only required if browseDirection is BACKWARD.

Y

lastEntryValue

xs:string

Specifies the value for the last record returned by the previous browse request. Only required if browseDirection is FORWARD.

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

BrowseReservePagingResponse

The BrowseReservePagingRequest 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.

exactMatchFound

xs:string

0..1

Acts as an indication of whether the system found an exact match. If present and empty, an exact match was found. If not present, no exact match was found.

Only displayed for BrowseReserveRequest.

reserveInfo

ReserveInfo

0..*

Displays ReserveInfo information.

closestMatch

xs:int

0..1

Displays the ID of the closest match to the browse string.

Only displayed for BrowseReserveRequest.

firstEntryID

xs:long

1

Displays the entry ID for the first record returned by the browse request.

lastEntryID

xs:long

1

Displays the entry ID of the last record returned by the browse request.

firstEntryValue

xs:string

1

Displays the entry value of the first record returned by the browse request.

lastEntryValue

xs:string

1

Displays the entry value of the last record returned by the browse 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.

Related topics 

 


© 2009-2012 SirsiDynix