GET api/Sites/{SiteId}/StudentSectionEnrollments
Returns the Student Section Enrollments for a Site.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
SiteId |
Application identifier for the Site |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of StudentSectionEnrollment objects for the specified SiteId
Collection of StudentSectionEnrollmentName | Description | Type | Additional information |
---|---|---|---|
StudentId |
The application identifier of the Student for the Section Enrollment. |
globally unique identifier |
None. |
SectionId |
The application identifier of the Section for the Section Enrollment. |
globally unique identifier |
None. |
EnrollmentCodeUid |
The Enrollment Code user identifier for the Section Enrollment. |
string |
None. |
EnrollmentCodeDescription |
The Enrollment Code description for the Section Enrollment. |
string |
None. |
DropCodeUid |
The Drop Code user identifier for the Section Enrollment. |
string |
None. |
DropCodeDescription |
The Drop Code description for the Section Enrollment. |
string |
None. |
BeginDate |
The begin date for the Section Enrollment. |
date |
None. |
EndDate |
The end date for the Section Enrollment. |
date |
None. |
LastEffectiveDate |
The last date the Student is effectively enrolled in the Section. |
date |
None. |
Id |
The application identifier for the object. This cannot be changed by the user. |
globally unique identifier |
None. |
DataVersion |
The version of the API data |
string |
None. |
ApiName |
The name of the object without the Api suffix |
string |
None. |
Response Formats
application/json, text/json
[ { "StudentId": "dd8885ad-1401-4766-bc7b-5ed027dfa4d0", "SectionId": "d639f5a7-0188-4539-bbd5-97ffdec4be19", "EnrollmentCodeUid": "sample string 3", "EnrollmentCodeDescription": "sample string 4", "DropCodeUid": "sample string 5", "DropCodeDescription": "sample string 6", "BeginDate": "2025-04-26T00:08:33.2405378-05:00", "EndDate": "2025-04-26T00:08:33.2405378-05:00", "LastEffectiveDate": "2025-04-26T00:08:33.2405378-05:00", "Id": "1205db71-42f3-4af5-84b2-ef5aaaaaf844", "DataVersion": "sample string 11", "ApiName": "" }, { "StudentId": "dd8885ad-1401-4766-bc7b-5ed027dfa4d0", "SectionId": "d639f5a7-0188-4539-bbd5-97ffdec4be19", "EnrollmentCodeUid": "sample string 3", "EnrollmentCodeDescription": "sample string 4", "DropCodeUid": "sample string 5", "DropCodeDescription": "sample string 6", "BeginDate": "2025-04-26T00:08:33.2405378-05:00", "EndDate": "2025-04-26T00:08:33.2405378-05:00", "LastEffectiveDate": "2025-04-26T00:08:33.2405378-05:00", "Id": "1205db71-42f3-4af5-84b2-ef5aaaaaf844", "DataVersion": "sample string 11", "ApiName": "" } ]
application/xml, text/xml
<ArrayOfStudentSectionEnrollment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1"> <StudentSectionEnrollment> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 11</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">1205db71-42f3-4af5-84b2-ef5aaaaaf844</Id> <BeginDate>2025-04-26T00:08:33.2405378-05:00</BeginDate> <DropCodeDescription>sample string 6</DropCodeDescription> <DropCodeUid>sample string 5</DropCodeUid> <EndDate>2025-04-26T00:08:33.2405378-05:00</EndDate> <EnrollmentCodeDescription>sample string 4</EnrollmentCodeDescription> <EnrollmentCodeUid>sample string 3</EnrollmentCodeUid> <LastEffectiveDate>2025-04-26T00:08:33.2405378-05:00</LastEffectiveDate> <SectionId>d639f5a7-0188-4539-bbd5-97ffdec4be19</SectionId> <StudentId>dd8885ad-1401-4766-bc7b-5ed027dfa4d0</StudentId> </StudentSectionEnrollment> <StudentSectionEnrollment> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 11</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">1205db71-42f3-4af5-84b2-ef5aaaaaf844</Id> <BeginDate>2025-04-26T00:08:33.2405378-05:00</BeginDate> <DropCodeDescription>sample string 6</DropCodeDescription> <DropCodeUid>sample string 5</DropCodeUid> <EndDate>2025-04-26T00:08:33.2405378-05:00</EndDate> <EnrollmentCodeDescription>sample string 4</EnrollmentCodeDescription> <EnrollmentCodeUid>sample string 3</EnrollmentCodeUid> <LastEffectiveDate>2025-04-26T00:08:33.2405378-05:00</LastEffectiveDate> <SectionId>d639f5a7-0188-4539-bbd5-97ffdec4be19</SectionId> <StudentId>dd8885ad-1401-4766-bc7b-5ed027dfa4d0</StudentId> </StudentSectionEnrollment> </ArrayOfStudentSectionEnrollment>