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 |
||||
Namespace |
http://schemas.sirsidynix.com/symws/reserve |
|||
Prerequisites |
|
|||
Request |
||||
Response |
||||
Operation faults |
(See also Faults) |
The LookupReservePagingRequest has the following request parameters:
Parameter |
Type |
Description |
Required? |
Specifies the maximum number of results to return for the request. If no value is specified, the default is 20. |
N |
||
Specifies the direction to use for retrieving the next set of paged results. |
Y |
||
Specify either firstEntryLineNum or lastEntryLineNum |
|||
Specifies the entry number for the first record returned by the previous lookup request. Only required if browseDirection is BACKWARD. |
Y |
||
Specifies the entry number for the last record returned by the previous lookup request. Only required if browseDirection is FORWARD. |
|||
Specifies the reserve desk value. If no value is specified, the default is ALL. |
N |
||
Specify either userPrimaryKey or userID |
|||
Specifies the database key of the instructor's user record. |
Y |
||
Specifies the ID of the instructor. The ID is typically a barcode, but depending on the ILS configuration, could be any string. |
|||
Specifies the ID of the course associated with the instructor and the reserve item. |
Y |
||
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 |
The LookupReservePagingRequest returns the following elements.
Element |
Type |
Occ. |
Description |
1 |
Displays the reserve desk value. |
||
0..1 |
Displays the ID of the instructor. |
||
0..1 |
Displays the instructor's name. |
||
0..1 |
Displays the department of the instructor associated with this reserve. |
||
0..1 |
Displays the ID of the course associated with the instructor and the reserve item. |
||
0..* |
Displays ReserveInfo information. |
||
0..1 |
Displays the total number results matching the request. |
||
1 |
Displays the entry number for the first record returned by the lookup request. |
||
1 |
Displays the entry number for the last record returned by the lookup request. |
||
1 |
Displays whether more results are available for a FORWARD browseType. |
||
1 |
Displays whether more results are available for a BACKWARD browseType. |
||
1 |
Displays the unique ID of the results. |
Related topics
© 2009-2012 SirsiDynix