Retrieve all entities (> 100) using list methods

[r-brown]

Vendor request

We need to retrieve all Licensees using RESTful API and list method; receive 100 entries out of more than 900 however. How all entries can be accessed?

[r-brown]

Indeed, every NetLicensing entity offering a list endpoint (REST), which can be used to provision NetLicensing data to other systems, such as DWH, BI, Reporting, etc.

The result set of the list operations is limited to 100 entries and contains information about data set available in the NetLicensing:

• pagenumber - current page index (0..N-1); where N - total pages count, see also totalpages
• itemsnumber - entities count returned; max: 100
• totalpages - total pages count calculated as modulo (totalitems % itemsnumber)
• totalitems - total entities available in the system
• hasnext - indicates whether the next page is available (true), otherwise false

Sample response

...
<ns2:items pagenumber="0" itemsnumber="100" totalpages="2" totalitems="108" hasnext="true">
  <ns2:item type="License">
...

In the case of hasnext attribute is set to true the next entities subset can be requested using following query params (supported by each list endpoint):

• page - page index (0..N-1)
• items - entities count to be returned; max: 100

Sample request / response

GET | https://go.netlicensing.io/core/v2/rest/licensee?filter=page=1;items=100

...
<ns2:items pagenumber="1" itemsnumber="8" totalpages="2" totalitems="108" hasnext="true">
  <ns2:item type="License">
...