Course Enrollment API Methods Updated

The Digication API can be used as an alternative to the CSV import (documented here) for the creation of users and courses, and the task of enrolling users into courses.  

For a daily sync of account and enrollment data, most schools opt to implement a school-hosted component that pulls data from a source (for example, the registrar's database), converts the data to the CSV format Digication expects, and posts the resulting file to Digication.  Instead of this daily batch approach, the API allows a school to develop custom software with the ability to modifiy user and course records one at a time.

The basic protocol and format of the Digication API are documented here

Available Methods

Course Methods

Method: course.list - lists courses

params:

courseid - digication internal id for the course, to specify a specific course, optionalpage - defaults to 1limit - courses per page, defaults to 250, max 250title - string for partial match in the course title, optionalsort - title or createdts, defaults to title

returns:

courses[n][startdts] - start date of the coursecourses[n][enddts] - end date of the coursecourses[n][courseid] - digication internal id for the coursecourses[n][title] - title of the coursecourses[n][coursenumber] - course numbercourses[n][otherid] - unique syncid of the coursecourses[n][description] - course description

 

Method: course.create - creates a courseparams:

coursetype - one of COURSE COMMUNITY or ASSESSMENTtitle - title of the coursecoursenumber - course number, optionaldescription - course description, optionalotherid - unique syncid of the coursestartdts - start date of the courseenddts - end date of the coursegradebookf - enables the gradebook, defaults to 0attendancef - enables attendance, defaults to 0discussionsf - enables discussions, defaults to 0portfoliosf - enables portfolios, defaults to 0assignmentf - enables assignments, defaults to 0standardf - enables standards, defaults to 0openenrollf - enables self enrollment, defaults to 0

returns:

courseid - digication internal id of the courseotherid - unique syncid of the course

 

Method: course.update - updates a course

params:same as course.create except:

courseid - the digication internal id of the coursecoursetype - optional on updatetitle - optional on updateotherid - optional on updatestartdts - optional on updateenddts - optional on update

returns:

courseid - digication internal id of the courseotherid - unique syncid of the course

 

Method: course.retrieve - returns course information for a course

params:

courseid - the digication internal id of the courseotherid - unique syncid of the course, required only if courseid is not specified

 

returns:

courseid - the digication internal id of the coursetitle - title of the coursecoursenumber - course number, optionaldescription - course description, optionalotherid - unique syncid of the coursestartdts - start date of the courseenddts - end date of the course

Enrollment Methods

Method: course.listusers - lists users (and groups) registered to a course

params:

courseid - the digication internal id of the courseotherid - unique syncid of the course, required only if courseid is not specified

 

returns:

users[n][userid] - digication internal id of the userusers[n][firstname] - first name of the userusers[n][lastname] - last name of thee userusers[n][username] - username of the userusers[n][otherid] - unique syncid of the userusers[n][school_email] - official email of the userusers[n][notify_email] - preferred contact email of the userusers[n][facultyf] - 1 if the user has faculty for the course, otherwise 0roles[n][roleid] - digication internal id of the grouproles[n][rolename] - name of the grouproles[n][facultyf] - 1 if the group has faculty access for the course, otherwise 0

Method: course.useradd - registers a user to a course

params:

course_otherid - unqiue syncid of the courseuser_otherid - unique syncid of the userfacultyf - enables faculty access for the user, default 0

 

returns:

nothing

 

Method: course.userremove - removes a user from a course

params:

course_otherid - unqiue syncid of the courseuser_otherid - unique syncid of the user

 

returns:

nothing

User Methods

Method: user.create - creates a user account

params:

username - username of the userotherid - unique syncid of the userfirstname - first name of the userlastname - last name of the userpassword - password of the user, optionaltimezonekey - time zone of the user, defaults to system time zoneemail - official email of the userfacultyf - 1 if the user is faculty, defaults to 0alumnif - 1 if the user is alumni, defaults to 0deactivatef - 1 if the user is deactivated, defaults to 0email_verified - enables automatic log in to support helpdesk as email address, default 0

 

returns:

otherid - unique syncid of the useruserid - digication internal id of the user

 

Method: user.update - updates user information for a user

params:same as user.create except:

userid - digication internal id of the userusername - optional on updateotherid - optional on updatefirstname - optional on updatelastname - optional on updateemail - optional on update

 

returns:

otherid - unique syncid of the useruserid - digication internal id of the user

 

Method: user.retrieve - returns user information for a user

params:one of the following:

userid - digication internal id of the userotherid - unique syncid of the userusername - username of the useremail - email address of the user

 

returns:

userid - digication internal id of the userotherid - unique syncid of the userusername - username of the userschool_email - official email address of the userfirstname - first name of the userlastname - last name of the userbirthday - the user's birthday major - the user's majorgraduation - the user's graduation yearwebsite - the user's websiteactivef - 0 if the user is deactivated, otherwise 1logindts - date of the user's last loginfacultyf - 1 if the user is faculty, otherwise 0

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.