DataSetPage

Models a page of a data set.

Supertype

None

Subtypes

None

JSON Representation

{
    "dataSetId" : string,
    "itemType" : string,
    "numberOfPages" : unsigned integer,
    "numberOfItemsPerPage" : unsigned integer,
    "totalNumberOfItems" : unsigned integer,      
    "items" : Item[],
    "currentPageIndex" : unsigned integer
}

Fields description

See JllmAPIException for a general description of the inherited field message.

Field	Meaning	Constraints
`dataSetId`	The identifier of the data set.	Valid API data set identifier.
`itemType`	Type of the items contained in the data set.	One of the Item subclass name, starting with a small letter : "quiz", "user", "userGroup", "computedResult". Same value in all pages of a same data set.
`numberOfPages`	The number of pages of the data set.	Positive integer. Equal to `totalNumberOfItems` / `numberOfItemsPerPage`, rounded up to the nearest integer.
`numberOfItemsPerPage`	The number of items contained in each page of the data set.	Positive integer. Same value in all pages.
`totalNumberOfItems`	The total number of items contained in the data set.	Positive integer.
`items`	The items contained in the current page.	Subset of the data set, containing at most `numberOfItemsPerPage` items.
`currentPageIndex`	Index of the current page.	Positive integer, between 1 and `numberOfItemsPerPage`. Not present if the data set is empty (`totalNumberOfItems` = 0).