[ARCHIVED] how to get total page of students list,teacher list,users list???

[vinhnq]

Dear Pro,

if I use API to show json array every lists below:

https://lsts.instructure.com/api/v1/accounts/1/users?per_page=100&page=1&role_filter_id=4&sort=usern...  --> list of teachers having 106 rows, if run this link just show 100 account of teachers. If want to show more then I must type page=2 such as:

https://lsts.instructure.com/api/v1/accounts/1/users?per_page=100&page=2&role_filter_id=4&sort=usern...

how to do for know in teachers account having how much total rows = total page => I set pagination on php to click [1] [2] [3]......[n]

please tell me, thank pro!

====================================================

[cronek]

Make your first call (page=1) and then examine the response headers.  You'll find something like this in the headers:

link: <https://lsts.instructure.com/api/v1/accounts/1/users?order=desc&role_filter_id=4&sort=username&page=1&per_page=100>; rel="current",<https://lsts.instructure.com/api/v1/accounts/1/users?order=desc&role_filter_id=4&sort=username&page=2&per_page=100>; rel="next",<https://lsts.instructure.com/api/v1/accounts/1/users?order=desc&role_filter_id=4&sort=username&page=1&per_page=100>; rel="first",<https://lsts.instructure.com/api/v1/accounts/1/users?order=desc&role_filter_id=4&sort=username&page=27&per_page=100>; rel="last"

The "link" header contains URLs  for "current", "next" (if current <> last), "first" and "last" calls to make for each response page.  You can just check for a "next" URL returned and call it until no more "next" URLs exist in the response.  Or, you can extract the max page=nn from the "last" URL to know how many pages there will be.

In Python, I do something like this:

output = ''

headers = {'Authorization': 'Bearer ' + apikey}
url = baseuri + uri

response = requests.get(url=url, headers=headers)
output = output + response.text

while 'next' in response.links:
     response = requests.get(url=response.links['next']['url'], headers=headers)
     output = output + response.text

print(output)

Work continues in the While loop until no "next" URL is returned.  All the response.text is just concatenated and usually results in well formed json.

[vinhnq]

how about use json like that:

// jquery
$.ajax({
url: '/api/v1/courses/:course_id/users',
method: 'GET',
data: {
enrollment_role: 'StudentEnrollment',
per_page: 100
}
}).done(function(r, x, s) { console.log(r) })

[vinhnq]

Dear Kelly Crone Willis,

can you make a template hmtl jquery with method GET https://lsts.instructure.com/api/v1/accounts/1/users?order=desc&role_filter_id=4&sort=username&page=... print into a table <tr> <td> for me make an example ???

I'm newer in canvas, so I need step by step from you.

thank you so much pro!

[cronek]

It looks like you are the right track with the ajax call above.  I called it from a Chrome console and it returns the array object.

Unfortunately, I work mostly from command line scripts as my ultimate goal is to extract the data into a spreadsheet or some other reporting system.  I convert the json to csv with the excellent command line tool jq (https://stedolan.github.io/jq/).  In the case of the Users API results, a jq filter like this will give you the key fields as csv:

canvas_api -q -u '/api/v1/accounts/1/users?search_term=krctest' | jq -r '.[]|[.id,.created_at,.name,.sis_user_id]|@csv'
534,"2016-10-27T13:46:47-05:00","Krc Test11","krctest11"
18676,"2016-12-08T15:12:08-06:00","Krc Test12","krctest12"
61237,"2018-04-09T10:52:55-05:00","Krc Test15","krctest15"
61238,"2018-04-09T10:53:29-05:00","Krc Test16","krctest16"
34922,"2017-01-19T13:22:39-06:00","Krc Test56","krctest56"
68244,"2018-09-12T09:16:13-05:00","Krc Test66","krctest66"

"canvas_api" is my Python script to pull data from an API endpoint.  Then I just pipe that output to "jq" to format it into csv.  If I send that to a file, I can just open in spreadsheet or import into a database table for further reporting.  If necessary, I can schedule that to run regularly via scheduler or cron.