Global Type: pageInfoType
General Description
This type is used for paging.
Name | Type | Attributes | Description |
---|---|---|---|
pageIndex | numberType | optional default=1 |
A serial index number of the page to be sent back. The indexing starts at: 1. When this is set to zero paging is disabled. |
pageSize | numberType | optional default=0 |
The maximum number of items that will be sent back in a page. The 'api.xmlmc.maxPageSize' system setting will limit the page size. |
<xs:complexType name="pageInfoType">
<xs:annotation>
<xs:documentation>
<![CDATA[This type is used for paging.]]>
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="pageIndex" type="numberType" minOccurs="0" default="1">
<xs:annotation>
<xs:documentation>
<![CDATA[A serial index number of the page to be sent back. The indexing starts at: 1.
When this is set to zero paging is disabled.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="pageSize" type="numberType" minOccurs="0" default="0">
<xs:annotation>
<xs:documentation>
<![CDATA[The maximum number of items that will be sent back in a page.
The 'api.xmlmc.maxPageSize' system setting will limit the page size.]]>
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>