Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Option Values

Default Option

Description

paging

true | false

true

Indicates weather to return lists of elements in pages

page

number

1

Defines which page number to return

pageSize

number

10

Defines the number of elements to return for each page.

example:

GET Request

method: GET

url: api/v1/locator?paging=true&page=2&pageSize=5

POST Request

method: POST

url: api/v1/locator

payload:

Code Block
languagejson
{
  "paging": "true",
  "page": "5",
  "pageSize": "5"
}

Response:

Code Block
languagejson
{
  "status": 200,
  "pager": {
    "page": 2,
    "pageCount": 120,
    "total": 243,
    "pageSize": 5,
    "nextPage": "{{host}}/api/v1/locator?paging=true&page=3&pageSize=5",
    "prevPage": "{{host}}/api/v1/locator?paging=true&page=3&pageSize=5"
  },
  "data": {...}
}