Pagination support?

[Nedlinin]

It looks like some endpoints limit you to say 20 results by default and might provide links to the next set of data within the result. Are there any plans to support this pagination today?

[jbeuckm]

That seems like a good thing to support. PR welcome or maybe you could give an example of how to find the link to next page of results?

[Nedlinin]

I've just started playing with the API to try to write something to help out my school teacher wife. I'm hoping to delve deeper into it this weekend and will hopefully be able to write up some examples then.

[Nedlinin]

@jbeuckm : The example requested:

As can be seen in this snippet, if you request something that paginates and it has enough to require pagination you get a property called "links" with a "next" subprop. You simply need to rerequest the next level.

  {
    "message": [
     <message-objects>
    ],
    "links": {
      "self": "https://api.schoology.com/v1/messages/sent?start=0&limit=20",
      "next": "https://api.schoology.com/v1/messages/sent?start=20&limit=20"
    }
  }

The limit can actually be set (though I'm not sure what the values max is) with a simple query string so using the library as is I can do something like..

const messages = await client.makeRequest("get", `/messages/${box}/${urlAdditions}`)

where urlAdditions is

?start=0&limit=100

And I get up to 100 objects back.

I think simply adding a more accessible "start" and "limit" property to some calls is a great start and then perhaps adding a "autoPaginate" property to allow it to continue grabbing until the end is hit or we hit some maximum desired by the user.