Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 759 Bytes

page.md

File metadata and controls

29 lines (19 loc) · 759 Bytes

Page

Use this field to specify paginate your results, by using page size and number. You can use one of the following methods:

/endpoint?page={ "number": 1, "size": 50 }

/endpoint?page[number]=1&page[size]=50

Structure

Page

Fields

Name Type Tags Description Getter Setter
number ?int Optional The current page number of the page to be retrieved.
Constraints: >= 1
getNumber(): ?int setNumber(?int number): void
size ?int Optional The maximum number of records ta will be returned per page.
Constraints: >= 1, <= 5000
getSize(): ?int setSize(?int size): void

Example (as JSON)

{
  "number": 1,
  "size": 50
}