GET api/Sites/{SiteId}/StudentEnrollments

Returns the Student Enrollments for a Site.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "012fdd83-a478-4ee0-9c9e-fcf04630a4e1",
    "SiteId": "068f9cf8-7a8f-46b8-818b-67b9d562ea09",
    "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-04-26T00:23:26.6834404-05:00",
    "ExitDate": "2025-04-26T00:23:26.6834404-05:00",
    "LastEffectiveDate": "2025-04-26T00:23:26.6834404-05:00",
    "SiteUid": "sample string 14",
    "GradeUid": "sample string 15",
    "PreviousSchool": "sample string 16",
    "Id": "31a51edc-5227-435e-8ec7-b350bb9d65b9",
    "DataVersion": "sample string 18",
    "ApiName": ""
  },
  {
    "StudentId": "012fdd83-a478-4ee0-9c9e-fcf04630a4e1",
    "SiteId": "068f9cf8-7a8f-46b8-818b-67b9d562ea09",
    "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-04-26T00:23:26.6834404-05:00",
    "ExitDate": "2025-04-26T00:23:26.6834404-05:00",
    "LastEffectiveDate": "2025-04-26T00:23:26.6834404-05:00",
    "SiteUid": "sample string 14",
    "GradeUid": "sample string 15",
    "PreviousSchool": "sample string 16",
    "Id": "31a51edc-5227-435e-8ec7-b350bb9d65b9",
    "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">31a51edc-5227-435e-8ec7-b350bb9d65b9</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-04-26T00:23:26.6834404-05:00</EntryDate>
    <ExitCodeDescription>sample string 8</ExitCodeDescription>
    <ExitCodeUid>sample string 7</ExitCodeUid>
    <ExitDate>2025-04-26T00:23:26.6834404-05:00</ExitDate>
    <GradeUid>sample string 15</GradeUid>
    <LastEffectiveDate>2025-04-26T00:23:26.6834404-05:00</LastEffectiveDate>
    <PreviousSchool>sample string 16</PreviousSchool>
    <SiteId>068f9cf8-7a8f-46b8-818b-67b9d562ea09</SiteId>
    <SiteUid>sample string 14</SiteUid>
    <StudentId>012fdd83-a478-4ee0-9c9e-fcf04630a4e1</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">31a51edc-5227-435e-8ec7-b350bb9d65b9</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-04-26T00:23:26.6834404-05:00</EntryDate>
    <ExitCodeDescription>sample string 8</ExitCodeDescription>
    <ExitCodeUid>sample string 7</ExitCodeUid>
    <ExitDate>2025-04-26T00:23:26.6834404-05:00</ExitDate>
    <GradeUid>sample string 15</GradeUid>
    <LastEffectiveDate>2025-04-26T00:23:26.6834404-05:00</LastEffectiveDate>
    <PreviousSchool>sample string 16</PreviousSchool>
    <SiteId>068f9cf8-7a8f-46b8-818b-67b9d562ea09</SiteId>
    <SiteUid>sample string 14</SiteUid>
    <StudentId>012fdd83-a478-4ee0-9c9e-fcf04630a4e1</StudentId>
  </StudentEnrollment>
</ArrayOfStudentEnrollment>