Skip to content

0.7 Paging Semantics

Jump to bottom
Kurtis Nusbaum edited this page Jun 8, 2013 · 2 revisions

The UDJ-Server has common semantics for calls that may return a large amount of data.

These calls support the following parameters:

  • max_results: The maximum number of results that will be returned.
  • start_position: The element number to start at. Defaults to 0.

If you do a query "GET /somelist?max_results=100&start_position=200" you will get results 200,201,...,299.

If start_position is greater than the total number of results, an empty list will be returned.

Servers MAY choose to arbitrarily restrict the max_results parameter for various API calls which support paging semantics. For example, a server may decide that it will never return more than 200 players when doing a player search. An requests asking for more will return with truncated results.

Clone this wiki locally