PageResponseControl DataObject
PageResponseControl returns the requested search results along with a cookie to enable the requestor to get the next page.
The structure of a PageResponseControl data object consists of:
- totalSize
- indicates the size of the page.
- cookie
- contains the cookie that is returned to the PageControl to enable the server to get the next page to the search.
XML schema definition
The following is the XML schema
definition for the PageResponseControl DataObject:
<xsd:complexType name="PageResponseControl">
<xsd:complexContent>
<xsd:extension base="Control">
<xsd:attribute name="totalSize" type="xsd:int"/>
<xsd:attribute name="cookie" type="xsd:hexBinary"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Sample data graph
Following is a sample PageResponseControl
data object returned from the search API. If a page is the last page, no PageResposneControl
is returned.
<wim:controls xsi:type="wim:PageResponseControl"
cookie="57494D53656172636843616368654E616D6574696D653A31313239353538343136383636"
totalSize="15"/>