API/Model Schema

[george_markaria]

We are beginning to develop an application which will make calls to the various API's and return data. however we are running into an issue with certain API's which do not contain a Model Schema, according to the live docs.

In particular, an example would be the call to the Analytics API. In the docs, this does not contain a Model Schema nor does it return a Link in the header response.

Why do some API calls return a Link in the header and others do not? I rely on the Link to determine the number or pages and the results.

Should I rely on the return of Link in the header to determine the results an paginate through the data?

Thanks, George

Nevada State College

[aclement]

George,

The link header is only present when there are more pages in the response to your query. If there is no link in the header, then the response is complete. On the analytics page, there are example responses that should help you construct a model to store the results of each query.

AC

[garth]

Looking at the Analytics API document, it does look like sample response objects are provided.

I am looking at this document:

Analytics - Canvas LMS REST API Documentation

Is this the same document you are referring to?

Regarding your need to determine how many pages of data you need to request, take a look at this document:

Pagination - Canvas LMS REST API Documentation

This may provide some clarity, and information on how to request a specific number of results per page, specifically the per_page parameter.