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 |
||||
Namespace |
http://schemas.sirsidynix.com/symws/reserve |
|||
Prerequisites |
|
|||
Request |
||||
Response |
||||
Operation faults |
(See also Faults) |
The ListReservePagingRequest 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 reserve desk value. If no value is specified, the default is ALL. |
N |
||
Specifies the searching type to use for the request. For example, you can search by course name. |
Y |
||
Specifies the direction to use for retrieving the next set of paged results. |
Y |
||
Specify either firstLineNum or lastLineNum |
|||
Specifies the entry line number for the first record returned by the previous list request. Only required if browseDirection is BACKWARD. |
Y |
||
Specifies the entry line number for the last record returned by the previous list request. Only required if browseDirection is FORWARD. |
|||
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 |
|||
Specifies the database key of the instructor's user record. |
Y (if browseType is USER_NAME) |
||
Specifies the ID or name of the instructor. The ID is typically a barcode, but depending on the ILS configuration, could be any string. |
|||
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 |
The ListReservePagingRequest returns the following elements.
Element |
Type |
Occ. |
Description |
1 |
Displays the type of browse used for the request. |
||
1 |
Displays the reserve desk value. |
||
0..1 |
Displays the ID of the instructor. This element is only returned here if the browseType is USER_NAME. |
||
0..1 |
Displays the instructor's name. This element is only returned here if the browseType is USER_NAME. |
||
0..1 |
Displays the department of the instructor associated with this reserve. This element is only returned here if the browseType is USER_NAME. |
||
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. |
||
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. |
||
0..* |
Displays ReserveInfo information. |
||
1 |
Displays the total number results matching the request. |
||
1 |
Displays the entry line number for the first record returned by the list request. |
||
1 |
Displays the entry line number for the last record returned by the list 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