GET api/Sites/{SiteId}/StudentEnrollments
Returns the Student 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 StudentEnrollment objects for the specified SiteId
Collection of StudentEnrollment| Name | Description | Type | Additional information |
|---|---|---|---|
| StudentId |
The application identifier of the Student for the Enrollment. |
globally unique identifier |
None. |
| SiteId |
The application identifier of the Site for the Enrollment. |
globally unique identifier |
None. |
| EntryCodeUid |
The Entry Code user identifier for the Enrollment. |
string |
None. |
| EntryCodeDescription |
The Entry Code description for the Enrollment. |
string |
None. |
| BasisOfAdmissionCodeUid |
The Basis of Admission Code user identifier for the Enrollment. |
string |
None. |
| BasisOfAdmissionCodeDescription |
The Basis of Admission Code description for the Enrollment. |
string |
None. |
| ExitCodeUid |
The Exit Code user identifier for the Enrollment. |
string |
None. |
| ExitCodeDescription |
The Exit Code description for the Enrollment. |
string |
None. |
| DropOutReasonCodeUid |
The Drop Out Reason Code user identifier for the Enrollment. |
string |
None. |
| DropOutReasonCodeDescription |
The Drop Out Reason Code description for the Enrollment. |
string |
None. |
| EntryDate |
The entry date for the Enrollment. |
date |
None. |
| ExitDate |
The exit date for the Enrollment. |
date |
None. |
| LastEffectiveDate |
The last date the Student is effectively enrolled in the Site. |
date |
None. |
| SiteUid |
The Site user identifier for the Enrollment. |
string |
None. |
| GradeUid |
The Grade user identifier for the Enrollment. |
string |
None. |
| PreviousSchool |
The previous school in which the Student was enrolled. |
string |
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
Sample:
[
{
"StudentId": "cf55abc3-91ef-4982-853c-fa469551fc47",
"SiteId": "f8150426-fe88-413b-81f7-e81abb940b83",
"EntryCodeUid": "sample string 3",
"EntryCodeDescription": "sample string 4",
"BasisOfAdmissionCodeUid": "sample string 5",
"BasisOfAdmissionCodeDescription": "sample string 6",
"ExitCodeUid": "sample string 7",
"ExitCodeDescription": "sample string 8",
"DropOutReasonCodeUid": "sample string 9",
"DropOutReasonCodeDescription": "sample string 10",
"EntryDate": "2025-06-15T03:31:49.1220419-05:00",
"ExitDate": "2025-06-15T03:31:49.1220419-05:00",
"LastEffectiveDate": "2025-06-15T03:31:49.1220419-05:00",
"SiteUid": "sample string 14",
"GradeUid": "sample string 15",
"PreviousSchool": "sample string 16",
"Id": "0d5424b1-5cb5-4ae6-bccd-514dd7a4c190",
"DataVersion": "sample string 18",
"ApiName": ""
},
{
"StudentId": "cf55abc3-91ef-4982-853c-fa469551fc47",
"SiteId": "f8150426-fe88-413b-81f7-e81abb940b83",
"EntryCodeUid": "sample string 3",
"EntryCodeDescription": "sample string 4",
"BasisOfAdmissionCodeUid": "sample string 5",
"BasisOfAdmissionCodeDescription": "sample string 6",
"ExitCodeUid": "sample string 7",
"ExitCodeDescription": "sample string 8",
"DropOutReasonCodeUid": "sample string 9",
"DropOutReasonCodeDescription": "sample string 10",
"EntryDate": "2025-06-15T03:31:49.1220419-05:00",
"ExitDate": "2025-06-15T03:31:49.1220419-05:00",
"LastEffectiveDate": "2025-06-15T03:31:49.1220419-05:00",
"SiteUid": "sample string 14",
"GradeUid": "sample string 15",
"PreviousSchool": "sample string 16",
"Id": "0d5424b1-5cb5-4ae6-bccd-514dd7a4c190",
"DataVersion": "sample string 18",
"ApiName": ""
}
]
application/xml, text/xml
Sample:
<ArrayOfStudentEnrollment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1">
<StudentEnrollment>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 18</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">0d5424b1-5cb5-4ae6-bccd-514dd7a4c190</Id>
<BasisOfAdmissionCodeDescription>sample string 6</BasisOfAdmissionCodeDescription>
<BasisOfAdmissionCodeUid>sample string 5</BasisOfAdmissionCodeUid>
<DropOutReasonCodeDescription>sample string 10</DropOutReasonCodeDescription>
<DropOutReasonCodeUid>sample string 9</DropOutReasonCodeUid>
<EntryCodeDescription>sample string 4</EntryCodeDescription>
<EntryCodeUid>sample string 3</EntryCodeUid>
<EntryDate>2025-06-15T03:31:49.1220419-05:00</EntryDate>
<ExitCodeDescription>sample string 8</ExitCodeDescription>
<ExitCodeUid>sample string 7</ExitCodeUid>
<ExitDate>2025-06-15T03:31:49.1220419-05:00</ExitDate>
<GradeUid>sample string 15</GradeUid>
<LastEffectiveDate>2025-06-15T03:31:49.1220419-05:00</LastEffectiveDate>
<PreviousSchool>sample string 16</PreviousSchool>
<SiteId>f8150426-fe88-413b-81f7-e81abb940b83</SiteId>
<SiteUid>sample string 14</SiteUid>
<StudentId>cf55abc3-91ef-4982-853c-fa469551fc47</StudentId>
</StudentEnrollment>
<StudentEnrollment>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 18</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">0d5424b1-5cb5-4ae6-bccd-514dd7a4c190</Id>
<BasisOfAdmissionCodeDescription>sample string 6</BasisOfAdmissionCodeDescription>
<BasisOfAdmissionCodeUid>sample string 5</BasisOfAdmissionCodeUid>
<DropOutReasonCodeDescription>sample string 10</DropOutReasonCodeDescription>
<DropOutReasonCodeUid>sample string 9</DropOutReasonCodeUid>
<EntryCodeDescription>sample string 4</EntryCodeDescription>
<EntryCodeUid>sample string 3</EntryCodeUid>
<EntryDate>2025-06-15T03:31:49.1220419-05:00</EntryDate>
<ExitCodeDescription>sample string 8</ExitCodeDescription>
<ExitCodeUid>sample string 7</ExitCodeUid>
<ExitDate>2025-06-15T03:31:49.1220419-05:00</ExitDate>
<GradeUid>sample string 15</GradeUid>
<LastEffectiveDate>2025-06-15T03:31:49.1220419-05:00</LastEffectiveDate>
<PreviousSchool>sample string 16</PreviousSchool>
<SiteId>f8150426-fe88-413b-81f7-e81abb940b83</SiteId>
<SiteUid>sample string 14</SiteUid>
<StudentId>cf55abc3-91ef-4982-853c-fa469551fc47</StudentId>
</StudentEnrollment>
</ArrayOfStudentEnrollment>