Changes between Version 4 and Version 5 of APIPaginate

Timestamp:

11/28/08 09:43:24 (22 months ago)

Author:

derk (IP: 82.210.124.225)

Comment:

--

APIPaginate

@@ -6 +6 @@
 You can check in the [wiki:APIMethods method list] which methods are affected by pagination. This are all methods that have the potential to return a number of results not limited by any other means. This are calls like "give me all the X for Y" (all the media for an album, all the gadgets for a user, etc). Not affected are calls that are called by lists of ids: if you are requesting information for a list of 500 userids, we assume you need the information for all 500 userids, so it would make little sense to split the list up in pages. (note that there is a maximum to the number of ids one can supply to any function).
 
-Pagination is controlled by the ha_page and ha_resultsperpage parameters. These parameters are optional to all methods that support pagination, and not allowed with any other method. If omitted, 12 results from page 1 are shown. If the ha_page is larger than the number of pages (which means that ha_page * ha_resultsperpage > totalitems), an empty resultset is shown. If ha_pages <= 0, an [wiki:APIErrors#errornumber33 error number 33] is returned. Similarly, if ha_resultsperpage is larger than the maximum allowed (currently 100), or <= 0, an [wiki:APIErrors#errornumber34 error number 34] is returned.
+Pagination is controlled by the '''ha_page''' and '''ha_resultsperpage''' parameters. These parameters are optional to all methods that support pagination, and not allowed with any other method. If omitted, 12 results from page 1 are shown. If the ha_page is larger than the number of pages (which means that ha_page * ha_resultsperpage > totalitems), an empty resultset is shown. If ha_pages <= 0, an [wiki:APIErrors#errornumber33 error number 33] is returned. Similarly, if ha_resultsperpage is larger than the maximum allowed (currently 100), or <= 0, an [wiki:APIErrors#errornumber34 error number 34] is returned.
 
 Pagination only makes sense when the result is ordered in some way. The methods that are paginated all have an order similar to the one we use on the site. The exact order is shown in the [wiki:APIMethods method list].