Data-API

The info block is present in each response and has some standard information and some information that differs from method to method.

Standard information

• timestamp_difference: signed difference between the timestamp sent in the request, and the timestamp on the server. If this number is larger than 2, you might need to resync the time on your server. A positive number means that our server has a higher timestamp than yours.
• running_milliseconds: the number of milliseconds that the call took to complete on our side.

Paginate information

For methods that support pagination, the following information is present.

• totalresults: the total number of records in the resultset.
• resultsperpage: the number of results per page. This is the supplied ha_resultsperpage parameter, or the default of 12 if this parameter is not present. Note that the actual number of results may be less than this number, if currentpage == totalpages.
• totalpages: the total number of pages that the resultset is distributed over. If there are no results, this is still 1. Programmattically, this is max(ceil(totalpages / resultsperpage),1).
• currentpage: the number of the current page. This is the supplied ha_page, or the default of 1 if this parameter is not present. Note that 1 is the first page, there is no page 0.

Suggestions

If you think there should be more information added to the info block, please let us know at hyves-api[at]hyves[dot]nl