Search in this section

Child pages
  • View Element
Skip to end of metadata
Go to start of metadata


Table of contents

Description

The view element is responsible for determining the range of the search result.

Structure

KeyOccursTypeFormatDescription
offset0 - 1String

Defines the starting position of the returned result.

children0 - 1boolean

Query subusers

  • 0 = Subusers are not queried
  • 1 = Subusers are queried
 limit0 - 1String
Maximum number of objects to be displayed.

XML Example

XML Example
<view>
    <limit>10</limit>
    <offset>0</offset>
    <children>0</children>
</view>

Code Example

View Component Java
@XmlRootElement(name = "view")
public class View {

    @XmlElement(name="offset")
    private Integer offset;

    @XmlElement(name="limit")
    private Integer limit;

    @XmlElement(name="children")
    private boolean children;

    /* Getter + Setter */

}
View Component PHP
class View {

    /**
     *
     * @var type Integer
     */
    public $offset;

    /**
     *
     * @var type Integer
     */
    public $limit;

    /**
     *
     * @var type boolean
     */
    public $children;

    /* Getter + Setter */

}
View Component C#
public class View {

    private Integer offset;

    private Integer limit;

    private boolean children;

    /* Getter + Setter */

}