 | AcademicServiceGetSchoolSectionsWithRosters Method |
Gets all sections (and rosters) defined for a school/division.
Namespace:
(Default Namespace)
Assembly:
SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntaxpublic SectionWithRoster[] GetSchoolSectionsWithRosters(
string schoolID,
bool nextYear,
int markingPeriodID,
bool includeRosters,
string authKey
)
Public Function GetSchoolSectionsWithRosters (
schoolID As String,
nextYear As Boolean,
markingPeriodID As Integer,
includeRosters As Boolean,
authKey As String
) As SectionWithRoster()
public:
array<SectionWithRoster^>^ GetSchoolSectionsWithRosters(
String^ schoolID,
bool nextYear,
int markingPeriodID,
bool includeRosters,
String^ authKey
)
public function GetSchoolSectionsWithRosters(
schoolID : String,
nextYear : boolean,
markingPeriodID : int,
includeRosters : boolean,
authKey : String
) : SectionWithRoster[]
function GetSchoolSectionsWithRosters(schoolID, nextYear, markingPeriodID, includeRosters, authKey);
Parameters
- schoolID
- Type: SystemString
The School ID. - nextYear
- Type: SystemBoolean
If set to False, it will return Sections for the current academic year, otherwise
it will return Sections for the next year. - markingPeriodID
- Type: SystemInt32
The desired marking period (or 0). - includeRosters
- Type: SystemBoolean
If set to True, it will return Rosters for each section. Set to False to just get a list of sections. - authKey
- Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.
Return Value
Type:
SectionWithRosterA list of
Section objects with an addition list of
Roster objects.
Exceptions
RemarksA marking period is required since students may withdraw during the year. The marking period
will restrict the students to only those who were in the section during that marking period.
Use marking period = 0 to only show those students who never withdrew.
The authorization key provided must be linked to an administrator role.
See Also