infoRouter Document Management System Web Services API

infoRouter Document Management System - Web Services API Documentation

GetPreviousSearchPage

Gets previous search page of the search results.

Syntax

[Visual Basic]
Public Shared Function GetPreviousSearchPage(ByVal AuthenticationTicket As String, _
                                          ByVal withrules As Boolean, _
                                          ByVal withPropertySets As Boolean, _
                                          ByVal withSecurity As Boolean, _
                                          ByVal withOwner As Boolean, _
                                          ByVal withVersions As Boolean) As System.Xml.XmlDocument

Parameters

AuthenticationTicket: infoRouter Authentication Ticket
withRules: to get folder rules with the results
withPropertySets: to get applied property set values with the results
withSecurity: to get applied permissions with the results
withOwner: to get owner information with the results
withVersions: to get document version informationwith the results

Return Value

returns xml fragment.
<response success="true" error="" FirstPage="True" LastPage="True" from="1" to="20">
if success attribute is "true", the results have been received succesfully.
if success attribute is "false", the error attribute indicates the encountered error.
The "from" and "To" attributes indicate bookmarks.
The total number of the results cannot be retrived until the Last Page attribute is set to TRUE.

Remarks

The search method must be called prior to calling this method.
Any user may invoke this call, including anonymous.
The search results are filtered according to the userid used to call this method.
Filtering is based on users access to domains, folders, and documents.
Documents with at least "Read" permissions are returned.

Example

Sub prevPage_Sample()
        Const AuthenticationTicket as String="sid-xxxxxxxxxxxxxx"
        Dim IR_OBJ As InfoRouter.srv
        Dim xmlResponse As System.Xml.XmlElement
        Try
            ClearOutputWindow()
            Application.DoEvents()
            Me.ActiveForm.Cursor = Cursors.WaitCursor

            IR_OBJ = New InfoRouter.srv
            IR_OBJ.Url = (txtSrvUrl.Text & "/srv.asmx")

            xmlResponse = IR_OBJ.GetPrevSearchPage(AuthenticationTicket, _
                                                   False, False, False, False, False)
            If xmlResponse.GetAttribute("success") = "true" Then
                Dim xmlitem As System.Xml.XmlElement
                For Each xmlitem In xmlResponse
                    If xmlitem.Name = "document" Then
                        WriteOutputLine("Document:" & xmlitem.GetAttributeNode("Name").Value & vbCrLf)
                    End If
                    If xmlitem.Name = "folder" Then
                        WriteOutputLine("folder:" & xmlitem.GetAttributeNode("Name").Value & vbCrLf)
                    End If

                Next
            Else
                WriteOutputLine("The previous page cannot be received.")
                WriteOutputLine("server response:" & xmlResponse.GetAttribute("error"))
            End If
            xmlResponse = Nothing

        Catch ex As Exception
            WriteOutputLine("error:" & ex.Message)
        Finally
            IR_OBJ = Nothing
            Me.ActiveForm.Cursor = Cursors.Default
        End Try

    End Sub