E2020API ClassA Sandcastle Documented Class Library
The Main API class containing all of the API functions
Inheritance Hierarchy

SystemObject
  WCFAPIE2020API

Namespace: WCFAPI
Assembly: WCFAPI (in WCFAPI.dll) Version: 4.0.0.0 (4.0.0.0)
Syntax

public class E2020API : IE2020API

The E2020API type exposes the following members.

Methods

  NameDescription
Public methodAnyOutstandingEssays
Checks to see if there are any outstanding essays prior to marking a course as completed
Public methodApproveReview
This method approves a course lesson for a given student.
Public methodArchiveStudent
Archive (disable) Student
Public methodAssignCourse
This method creates a new course for a given student.
Public methodCreateStudent
This method creates a new student in the system in the school of the API User.
Public methodCreateStudentInSchool
This method creates a new student in the system in the school specified. Some options will inherit from the school.
Public methodCreateStudentWithUsername
This method creates a new student in the system in the school specified, with a pre-specified username
Public methodCreateTeacher
This method creates a new teacher in the system.
Public methodDisableCourse
This method disables an enabled course for a given student.
Public methodGetCourseStructure
Get Course structure given the External Course Code
Public methodGetDirectLoginURL
This method returns an encrypted url that can be used to directly log in as a given student.
Public methodGetReviewsRequired
This method returns all lessons for a given student that require a review.
Public methodGetSchoolCalendar
Get list of days off for a school for their calendar
Public methodGetSchoolCourseData
Get course information for a school
Public methodGetStudentCourseInfo
Get information about the courses assigned to a student
Public methodGetStudentCourseProgressData
Get StudentCourseProgressResults
Public methodGetStudentCourseStructure
Get A Student's Course structure given the External Course Code
Public methodGetStudentGrades
This method returns all grades for a given student for a range of up to 7 days.
Public methodGetStudentProgressData
This method returns course progress information for active courses for a given student.
Public methodGetStudentSessionLogs
This method returns all login session information for a given student for a range of up to 7 days.
Public methodGetUsersInSchool
Get all users in a given school
Public methodMarkCourseComplete
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.
Public methodReEnableCourse
Re-enables a given course for a given student
Public methodUpdateStudent
Public methodUpdateStudentCourseStartDate
Updates the start date for a specific student's course.
Public methodUpdateStudentCourseTargetDate
Updates the Target date for a specific student's course.
Public methodUpdateStudentSectionCode
Update a student's course to point to a different section
Public methodUsernameAvailability
Checks to see if a given username is unique, and if not returns a suggested username
Top
See Also

Reference