/curriculumstatus

Returns the curriculum completion status of users in context of their enrollment.

Optional Parameters:

Parameter

Description

Type

page

The specific page number in a paginated list of results

Including this parameter in your call will limit the response to a single page matching the page sequence order represented by the page number.

INT

pageSize

The number of items to include in the page of results 

Including this parameter in your call will adjust the response to only include no more than the number of items that you specify on each page.

Note: The value “100” will be used by default if the parameter is not explicitly set and the maximum value is “500”. 

INT

curriculumId

The ID of the curriculum to retrieve statuses for. Returns all participants in the requested curriculum. 

Note: Curriculum ID can be obtained via the administrative user interface by selecting the curriculum and reading the corresponding URL

1. See a list of curricula here: 
https://yoursite.collegiatelink.net/admin/curriculum

2. Choose a curriculum and read corresponding URL upon page load

Example: https://yoursite.collegiatelink.net/admin/curriculum/edit/22

The curriculumId is: 22

INT

curriculumName

The name of the curriculum to retrieve statuses for. Returns all participants in the requested curriculum.

STRING

username

The name of a specific user to retrieve the curriculum statuses for.  Returns information for all curricula that the user is a participant of.

STRING

Example: Calling for the completion status of all users in a specific curriculum

Sample Call:

https://yoursite.collegiatelink.net/api/curriculumstatus?curriculumid=22

Sample Response:

 

Example: Calling for the completion status of a specific user in all of their curricula

Sample Call:

https://yoursite.collegiatelink.net/api/curriculumstatus?username=ppaulson

Sample Response:

Example: Calling for the completion status of a specific user in a specific curriculum

Sample Call:

https://yoursite/api/curriculumstatus?curriculumid=22&username=ppaulson

Sample Response:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Need More Help?

Additional Support

Powered by Zendesk