GET api/StudentEnrollments/{StudentEnrollmentId}
Returns a Student Enrollment.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| StudentEnrollmentId |
Application identifier for the Student Enrollment |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
StudentEnrollment object for the specified StudentEnrollmentId
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
{
"StudentId": "5120a8c5-3f1b-4494-a399-9b284dc6c625",
"SiteId": "b9c69e48-aaa2-4ecb-8a24-e0e561d21283",
"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-15T02:39:48.1296303-05:00",
"ExitDate": "2025-06-15T02:39:48.1296303-05:00",
"LastEffectiveDate": "2025-06-15T02:39:48.1296303-05:00",
"SiteUid": "sample string 14",
"GradeUid": "sample string 15",
"PreviousSchool": "sample string 16",
"Id": "e8169647-96e7-4050-9d38-70210fd6187a",
"DataVersion": "sample string 18",
"ApiName": ""
}
application/xml, text/xml
<StudentEnrollment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1"> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 18</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">e8169647-96e7-4050-9d38-70210fd6187a</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-15T02:39:48.1296303-05:00</EntryDate> <ExitCodeDescription>sample string 8</ExitCodeDescription> <ExitCodeUid>sample string 7</ExitCodeUid> <ExitDate>2025-06-15T02:39:48.1296303-05:00</ExitDate> <GradeUid>sample string 15</GradeUid> <LastEffectiveDate>2025-06-15T02:39:48.1296303-05:00</LastEffectiveDate> <PreviousSchool>sample string 16</PreviousSchool> <SiteId>b9c69e48-aaa2-4ecb-8a24-e0e561d21283</SiteId> <SiteUid>sample string 14</SiteUid> <StudentId>5120a8c5-3f1b-4494-a399-9b284dc6c625</StudentId> </StudentEnrollment>