Subscriber Inventory Pagination

The pagination information permits the subscriber interface to only return a fraction of the list of matching subscribers, because the list of matching subscribers may be very long.

Given a list of matching subscribers, the pagination information permits OCS to navigate this list, only querying a chunk of it at a time. This is made by the following pagination parameters:
  • OCS sends a startIndex, indicating the index of the first subscriber to be returned in the list.
  • OCS sends a number of subscribers to return.
For example, if you send a query for "Ray", OCS sends the search string "Ray," with the number of subscribers to return of 10 and a start index of 0. If 25 subscribers are matching, the response is a list of 10 subscribers, indexes 0 to 9 in the list of matching subscribers. The response also contains the information that there are 25 matching subscribers. When you click to the next page, OCS resends a search with "Ray", with startIndex "10" and 10 subscribers to return. This returns subscriber numbers 10 to 19, indicating that there are 25 matching subscribers. Upon the next page, OCS issues the search with startIndex 20. 6 subscribers should then be returned (20 to 25).This pagination relies on the fact that the subscribers are ordered when the search is done (the list of matching subscribers is the same during the 3 search queries). To achieve this, a sort of the matching subscribers after the search must be applied, such as an alphabetical sort on last name. This guarantees search stability.
Note: The pagination functionality will be broken if the search is not stable.