1

With no scope enforced on the developer key, the following request returns the Course object along with the total_students and term information:

/api/v1/courses?include[]=term&include[]=total_students

After enforcing the scope and permitting only url:GET|/api/v1/courses , the Course object returns but does not include the terms or total_student fields.

I cannot find anything in the documentation (https://canvas.instructure.com/doc/api/courses.html#method.courses.index) that would indicate these two fields require additional scope. Does anyone know if that is the case and if so, what scope is required to get these two additional attributes?

user1392897
  • 831
  • 2
  • 9
  • 25

1 Answers1

2

There is a setting on the developer key for "Allow Include Parameters". When that option is disabled Canvas will ignore include and includes parameters.

You can read more about it here: https://canvas.instructure.com/doc/api/file.developer_keys.html under "Canvas API Includes"

Nathan
  • 196
  • 1
  • 4
  • Hi, I am using Virtual Machine from bitnami for Canvas LMS. Is this feature also available in older versions of canvas because I could not see the feature "Allow Include Parameters" option in "2018.12.08.24-0-r01-linux-debian-9-x86_64.vmx" however I noticed this feature in "bitnami-canvaslms-2020.03.11.23-0-linux-debian-9-x86_64.vmx"? Also from this [link](https://community.canvaslms.com/docs/DOC-18353-canvas-release-notes-2020-02-15) it sounds like it was introduce in Feb 15, 2020 release. Any help is highly appreciated. – Biraj Dhakal Jul 09 '20 at 12:07