E2020APIGetStudentCourseProgressData Method A Sandcastle Documented Class Library
Get StudentCourseProgressResults

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

public StudentCourseProgressResults GetStudentCourseProgressData(
	string apiUsername,
	string apiPassword,
	Nullable<int> SchoolId,
	Nullable<bool> EnabledStudents,
	Nullable<bool> EnabledCourses,
	Nullable<bool> CompletedCourses
)

Parameters

apiUsername
Type: SystemString
Username of the API user
apiPassword
Type: SystemString
Password of the APU user
SchoolId
Type: SystemNullableInt32
Id of School to filter to. Null for all schools user has permission to. No results returned if user does not have access to SchoolId passed in.
EnabledStudents
Type: SystemNullableBoolean
True for enabled students only, False for disabled students only, Null for all. Typically will want to use True.
EnabledCourses
Type: SystemNullableBoolean
True for enabled courses only, False for disabled courses only, Null for all. Typically will want to use Null. Corresponding with the Dashboard Course Status dropdown: All: EnabledCourses = Null, CompletedCourses = Null Active: EnabledCourses = True, CompletedCourses = False Disabled: EnabledCourses = False, CompletedCourses = False Completed: EnabledCourses = Null, CompletedCourses = True
CompletedCourses
Type: SystemNullableBoolean
True for completed courses only, False for incomplete courses only, Null for all. Typically will want to use Null.

Return Value

Type: StudentCourseProgressResults

[Missing <returns> documentation for "M:WCFAPI.E2020API.GetStudentCourseProgressData(System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"]

See Also

Reference