infoRouter Web Services API V7.5 -GetNextSearchPage

Syntax

Visual Basic (declaration)
Public Function GetNextSearchPage( _ ByVal AuthenticationTicket as String, _ ByVal withrules as bool, _ ByVal withPropertySets as bool, _ ByVal withSecurity as bool, _ ByVal withOwner as bool, _ ByVal withVersions as bool) as XmlNode

Visual Basic (declaration)

Public Function GetNextSearchPage( _ 
	ByVal AuthenticationTicket as String, _ 
	ByVal withrules as bool, _ 
	ByVal withPropertySets as bool, _ 
	ByVal withSecurity as bool, _ 
	ByVal withOwner as bool, _ 
	ByVal withVersions as bool) as XmlNode

C# (declaration)
public XmlNode GetNextSearchPage( string AuthenticationTicket, bool withrules, bool withPropertySets, bool withSecurity, bool withOwner, bool withVersions)

Parameters

AuthenticationTicket
    string infoRouter ticket
withrules
    bool to get folder rules with the results
withPropertySets
    bool to get property sets with the results
withSecurity
    bool to get access list with the results
withOwner
    bool to get owner information of the folder with the results
withVersions
    bool to get version information of the documents with 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 returns the bookmarks.
The total number of the results cannot be retrived until the Last Page attribute is set to TRUE.


<response success="true" error="" FirstPage="False" from="21" to="40" LastPage="False">
  <document DocumentID="11912" Name="InfoRouterV75-Requirements.pdf" Path="\infoRouter Collateral" Description="" UpdateInstructions="" CreationDate="2007-08-04 12:19:57" ModificationDate="2007-08-08 07:57:47" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="107902" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="0" DocTypeName="" VersionNumber="1000001" />
  <document DocumentID="11934" Name="Invoice Review and Payment Cycle.ppt" Path="\Accounting\Payables" Description="Please make sure to follow the procedures outlined in this document when paying for incoming invoices" UpdateInstructions="" CreationDate="2007-08-08 07:51:32" ModificationDate="2007-08-08 07:51:32" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="276480" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="0" RetentionDate="" DispositionDate="" DocTypeID="0" DocTypeName="" VersionNumber="1000000" />
  <document DocumentID="11878" Name="Invoice-34.pdf" Path="\View Types\Workflow View" Description="" UpdateInstructions="" CreationDate="2007-08-03 16:07:06" ModificationDate="2007-08-03 16:07:06" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7689" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="" VersionNumber="1000000" />
  <document DocumentID="11868" Name="Invoice-34.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:20" ModificationDate="2007-08-03 12:26:20" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7689" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11869" Name="Invoice-35.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:21" ModificationDate="2007-08-03 12:26:21" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7636" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11879" Name="Invoice-35.pdf" Path="\View Types\Workflow View" Description="" UpdateInstructions="" CreationDate="2007-08-03 16:07:07" ModificationDate="2007-08-03 16:07:07" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7636" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="" VersionNumber="1000000" />
  <document DocumentID="11880" Name="Invoice-36.pdf" Path="\View Types\Workflow View" Description="" UpdateInstructions="" CreationDate="2007-08-03 16:07:07" ModificationDate="2007-08-03 16:07:07" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7662" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="" VersionNumber="1000000" />
  <document DocumentID="11870" Name="Invoice-36.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:22" ModificationDate="2007-08-03 12:26:22" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7662" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11871" Name="Invoice-37.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:22" ModificationDate="2007-08-03 12:26:22" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="51761" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11881" Name="Invoice-37.pdf" Path="\View Types\Workflow View" Description="" UpdateInstructions="" CreationDate="2007-08-03 16:07:07" ModificationDate="2007-08-03 16:07:07" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="51761" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="" VersionNumber="1000000" />
  <document DocumentID="11872" Name="Invoice-38.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:22" ModificationDate="2007-08-03 12:26:22" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7665" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11853" Name="Invoice-39.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:16" ModificationDate="2007-08-03 12:26:16" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7660" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11854" Name="Invoice-40.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:17" ModificationDate="2007-08-03 12:26:17" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7650" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11855" Name="Invoice-42.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:17" ModificationDate="2007-08-03 12:26:17" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="8232" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11856" Name="Invoice-45.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:17" ModificationDate="2007-08-03 12:26:17" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7927" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11857" Name="Invoice-46.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:17" ModificationDate="2007-08-03 12:26:17" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7927" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11858" Name="Invoice-47.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:18" ModificationDate="2007-08-03 12:26:18" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="51740" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11859" Name="Invoice-48.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:18" ModificationDate="2007-08-03 12:26:18" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7958" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11860" Name="Invoice-51.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:18" ModificationDate="2007-08-03 12:26:18" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="8211" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
  <document DocumentID="11861" Name="Invoice-55.pdf" Path="\Accounting\Incoming Invoices" Description="" UpdateInstructions="" CreationDate="2007-08-03 12:26:19" ModificationDate="2007-08-03 12:26:19" CheckoutDate="" CheckoutBy="" CheckoutByUserName="" Size="7631" Type="Office Document" PercentComplete="0" CompletionDate="" Importance="1" RetentionDate="" DispositionDate="" DocTypeID="1014" DocTypeName="Invoice" VersionNumber="1000000" />
</response>

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

Visual Basic Example
Sub NextPage_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.GetNextSearchPage(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 next 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

Visual Basic Example

Sub NextPage_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.GetNextSearchPage(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 next 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

GetNextSearchPage

Syntax

Parameters

Return Value

Remarks

Example

See Also