The Main API class containing all of the API functions
Inheritance Hierarchy
WCFAPIE2020API
Namespace: WCFAPI
Assembly: WCFAPI (in WCFAPI.dll) Version: 4.0.0.0 (4.0.0.0)
Syntax
The E2020API type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| AnyOutstandingEssays |
Checks to see if there are any outstanding essays prior to marking a course as completed
| |
| ApproveReview |
This method approves a course lesson for a given student.
| |
| ArchiveStudent |
Archive (disable) Student
| |
| AssignCourse |
This method creates a new course for a given student.
| |
| CreateStudent |
This method creates a new student in the system in the school of the API User.
| |
| CreateStudentInSchool |
This method creates a new student in the system in the school specified. Some options will inherit from the school.
| |
| CreateStudentWithUsername |
This method creates a new student in the system in the school specified, with a pre-specified username
| |
| CreateTeacher |
This method creates a new teacher in the system.
| |
| DisableCourse |
This method disables an enabled course for a given student.
| |
| GetCourseStructure |
Get Course structure given the External Course Code
| |
| GetDirectLoginURL |
This method returns an encrypted url that can be used to directly log in as a given student.
| |
| GetReviewsRequired |
This method returns all lessons for a given student that require a review.
| |
| GetSchoolCalendar |
Get list of days off for a school for their calendar
| |
| GetSchoolCourseData |
Get course information for a school
| |
| GetStudentCourseInfo |
Get information about the courses assigned to a student
| |
| GetStudentCourseProgressData |
Get StudentCourseProgressResults
| |
| GetStudentCourseStructure |
Get A Student's Course structure given the External Course Code
| |
| GetStudentGrades |
This method returns all grades for a given student for a range of up to 7 days.
| |
| GetStudentProgressData |
This method returns course progress information for active courses for a given student.
| |
| GetStudentSessionLogs |
This method returns all login session information for a given student for a range of up to 7 days.
| |
| GetUsersInSchool |
Get all users in a given school
| |
| MarkCourseComplete |
Marks a course as completed for a given student and a given course.
NOTE: This assumnes you had previously run the API method AnyOutstandingEssays
to determine if there are any outstanding essays. This will mark the course completed
regardless if there are outstanding essays or not.
| |
| ReEnableCourse |
Re-enables a given course for a given student
| |
| UpdateStudent | ||
| UpdateStudentCourseStartDate |
Updates the start date for a specific student's course.
| |
| UpdateStudentCourseTargetDate |
Updates the Target date for a specific student's course.
| |
| UpdateStudentSectionCode |
Update a student's course to point to a different section
| |
| UsernameAvailability |
Checks to see if a given username is unique, and if not returns a suggested username
|
See Also