 | AcademicServiceGetRosterForSection Method |
Gets the class roster (student IDs) for section.
Namespace:
(Default Namespace)
Assembly:
SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntaxpublic Roster[] GetRosterForSection(
string schoolID,
string sectionID,
int markingperiodID,
bool nextYear,
string authKey
)
Public Function GetRosterForSection (
schoolID As String,
sectionID As String,
markingperiodID As Integer,
nextYear As Boolean,
authKey As String
) As Roster()
public:
array<Roster^>^ GetRosterForSection(
String^ schoolID,
String^ sectionID,
int markingperiodID,
bool nextYear,
String^ authKey
)
public function GetRosterForSection(
schoolID : String,
sectionID : String,
markingperiodID : int,
nextYear : boolean,
authKey : String
) : Roster[]
function GetRosterForSection(schoolID, sectionID, markingperiodID, nextYear, authKey);
Parameters
- schoolID
- Type: SystemString
The School ID. - sectionID
- Type: SystemString
The Section ID. - markingperiodID
- Type: SystemInt32
The desired marking period (or 0). - nextYear
- Type: SystemBoolean
If set to False, it will return the Students assigned to the Section for the current academic year, otherwise
it will return the Students assigned for the next year. - authKey
- Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.
Return Value
Type:
RosterA 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