GET api/Students/{SchoolYear}/{StudentId}
Returns a Student.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SchoolYear |
Numeric Value of the School Year (i.e. 2018 for the 2017-2018 School Year) |
integer |
Required |
| StudentId |
Application identifier for the Student |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Student object for the specified SchoolYear and StudentId
Student| Name | Description | Type | Additional information |
|---|---|---|---|
| StudentUid |
The user identifier for the Student. |
string |
None. |
| StatePrId |
The StatePrId for the Student. |
string |
None. |
| StudentPerson |
The Person for the Student. |
Person |
None. |
| BirthDateVerificationCodeUid |
The Birth Date Verification Code user identifier for the Student. |
string |
None. |
| BirthDateVerificationCodeDescription |
The Birth Date Verification Code description for the Student. |
string |
None. |
| BirthPlace |
The birth place for the Student. |
string |
None. |
| BirthState |
The birth state for the Student. |
string |
None. |
| BirthCountry |
The birth country for the Student. |
string |
None. |
| SiteUid |
The Site user identifier for the Student's current or last Enrollment in the School Year. |
string |
None. |
| GradeUid |
The Grade user identifier for the Student's current or last Enrollment in the School Year. |
string |
None. |
| HomeRoom |
The home room for the Student. |
string |
None. |
| EnrollmentStatus |
The enrollment status for the Student's current or last Enrollment in the School Year. Values: On_Roll, Off_Roll, Suspended |
string |
None. |
| IsEnrolled |
The indicator for whether the Student's current or last Enrollment is for the Site. |
boolean |
None. |
| Locker |
The locker for the Student. |
string |
None. |
| LockerCombination |
The combination of the locker for the Student. |
string |
None. |
| ParkingSpace |
The parking space for the Student. |
string |
None. |
| DefaultAddress |
The default address for the Student. |
Address |
None. |
| AddressList |
The addresses for the Student. This list includes the default address for the Student. |
Collection of Address |
None. |
| DefaultPhone |
The default phone for the Student. |
Phone |
None. |
| PhoneList |
The phones for the Student. This list includes the default phone for the Student. |
Collection of Phone |
None. |
| DefaultEmail |
The default email for the Student. |
None. |
|
| EmailList |
The emails for the Student. This list includes the default email for the Student. |
Collection of Email |
None. |
| SIFRefId |
The SIFRefId for the Student. |
globally unique identifier |
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
{
"StudentUid": "sample string 1",
"StatePrId": "sample string 2",
"StudentPerson": {
"Title": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"Suffix": "sample string 5",
"AlternateFirstName": "sample string 6",
"AlternateLastName": "sample string 7",
"SSN": "sample string 8",
"Gender": "sample string 9",
"BirthDate": "2025-11-04T09:04:48.5176186-06:00",
"HispanicLatino": true,
"AmericanIndian": true,
"White": true,
"Asian": true,
"PacificIslander": true,
"Black": true,
"UnknownRace": true,
"EmployerName": "sample string 18",
"LanguageCodeUid": "sample string 19",
"LanguageCodeDescription": "sample string 20",
"Id": "6f2ab952-5c6e-4f00-97f6-53498a998024",
"DataVersion": "sample string 22",
"ApiName": ""
},
"BirthDateVerificationCodeUid": "sample string 3",
"BirthDateVerificationCodeDescription": "sample string 4",
"BirthPlace": "sample string 5",
"BirthState": "sample string 6",
"BirthCountry": "sample string 7",
"SiteUid": "sample string 8",
"GradeUid": "sample string 9",
"HomeRoom": "sample string 10",
"EnrollmentStatus": "sample string 11",
"IsEnrolled": true,
"Locker": "sample string 13",
"LockerCombination": "sample string 14",
"ParkingSpace": "sample string 15",
"DefaultAddress": {
"AddressType": "sample string 1",
"AddressTypeDescription": "sample string 2",
"Line1": "sample string 3",
"Line2": "sample string 4",
"Line3": "sample string 5",
"Apartment": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Country": "sample string 9",
"PostalCode": "sample string 10",
"Zip": "sample string 11",
"ZipPlusFour": "sample string 12",
"RoomNumber": "sample string 13",
"Id": "bbbf5566-352f-4c36-97e8-0ec6d6d3faf0",
"DataVersion": "sample string 15",
"ApiName": ""
},
"AddressList": [
{
"AddressType": "sample string 1",
"AddressTypeDescription": "sample string 2",
"Line1": "sample string 3",
"Line2": "sample string 4",
"Line3": "sample string 5",
"Apartment": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Country": "sample string 9",
"PostalCode": "sample string 10",
"Zip": "sample string 11",
"ZipPlusFour": "sample string 12",
"RoomNumber": "sample string 13",
"Id": "bbbf5566-352f-4c36-97e8-0ec6d6d3faf0",
"DataVersion": "sample string 15",
"ApiName": ""
},
{
"AddressType": "sample string 1",
"AddressTypeDescription": "sample string 2",
"Line1": "sample string 3",
"Line2": "sample string 4",
"Line3": "sample string 5",
"Apartment": "sample string 6",
"City": "sample string 7",
"State": "sample string 8",
"Country": "sample string 9",
"PostalCode": "sample string 10",
"Zip": "sample string 11",
"ZipPlusFour": "sample string 12",
"RoomNumber": "sample string 13",
"Id": "bbbf5566-352f-4c36-97e8-0ec6d6d3faf0",
"DataVersion": "sample string 15",
"ApiName": ""
}
],
"DefaultPhone": {
"MessageDeviceType": "sample string 1",
"MessageDeviceTypeDescription": "sample string 2",
"Number": "sample string 3",
"Description": "sample string 4",
"Id": "b4f930fa-8329-4868-97bf-e08aceaf68cf",
"DataVersion": "sample string 6",
"ApiName": ""
},
"PhoneList": [
{
"MessageDeviceType": "sample string 1",
"MessageDeviceTypeDescription": "sample string 2",
"Number": "sample string 3",
"Description": "sample string 4",
"Id": "b4f930fa-8329-4868-97bf-e08aceaf68cf",
"DataVersion": "sample string 6",
"ApiName": ""
},
{
"MessageDeviceType": "sample string 1",
"MessageDeviceTypeDescription": "sample string 2",
"Number": "sample string 3",
"Description": "sample string 4",
"Id": "b4f930fa-8329-4868-97bf-e08aceaf68cf",
"DataVersion": "sample string 6",
"ApiName": ""
}
],
"DefaultEmail": {
"Address": "sample string 1",
"Description": "sample string 2",
"Id": "61bc3823-a36a-4e89-9c7f-28884299ac9e",
"DataVersion": "sample string 4",
"ApiName": ""
},
"EmailList": [
{
"Address": "sample string 1",
"Description": "sample string 2",
"Id": "61bc3823-a36a-4e89-9c7f-28884299ac9e",
"DataVersion": "sample string 4",
"ApiName": ""
},
{
"Address": "sample string 1",
"Description": "sample string 2",
"Id": "61bc3823-a36a-4e89-9c7f-28884299ac9e",
"DataVersion": "sample string 4",
"ApiName": ""
}
],
"SIFRefId": "c67d290d-b527-4ff3-bb4a-632bbca74baf",
"Id": "3a754807-4115-4c1f-bb9b-6ee4bd959a20",
"DataVersion": "sample string 18",
"ApiName": ""
}
application/xml, text/xml
<Student 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">3a754807-4115-4c1f-bb9b-6ee4bd959a20</Id>
<AddressList>
<Address>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">bbbf5566-352f-4c36-97e8-0ec6d6d3faf0</Id>
<AddressType>sample string 1</AddressType>
<AddressTypeDescription>sample string 2</AddressTypeDescription>
<Apartment>sample string 6</Apartment>
<City>sample string 7</City>
<Country>sample string 9</Country>
<Line1>sample string 3</Line1>
<Line2>sample string 4</Line2>
<Line3>sample string 5</Line3>
<PostalCode>sample string 10</PostalCode>
<RoomNumber>sample string 13</RoomNumber>
<State>sample string 8</State>
<Zip>sample string 11</Zip>
<ZipPlusFour>sample string 12</ZipPlusFour>
</Address>
<Address>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">bbbf5566-352f-4c36-97e8-0ec6d6d3faf0</Id>
<AddressType>sample string 1</AddressType>
<AddressTypeDescription>sample string 2</AddressTypeDescription>
<Apartment>sample string 6</Apartment>
<City>sample string 7</City>
<Country>sample string 9</Country>
<Line1>sample string 3</Line1>
<Line2>sample string 4</Line2>
<Line3>sample string 5</Line3>
<PostalCode>sample string 10</PostalCode>
<RoomNumber>sample string 13</RoomNumber>
<State>sample string 8</State>
<Zip>sample string 11</Zip>
<ZipPlusFour>sample string 12</ZipPlusFour>
</Address>
</AddressList>
<BirthCountry>sample string 7</BirthCountry>
<BirthDateVerificationCodeDescription>sample string 4</BirthDateVerificationCodeDescription>
<BirthDateVerificationCodeUid>sample string 3</BirthDateVerificationCodeUid>
<BirthPlace>sample string 5</BirthPlace>
<BirthState>sample string 6</BirthState>
<DefaultAddress>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">bbbf5566-352f-4c36-97e8-0ec6d6d3faf0</Id>
<AddressType>sample string 1</AddressType>
<AddressTypeDescription>sample string 2</AddressTypeDescription>
<Apartment>sample string 6</Apartment>
<City>sample string 7</City>
<Country>sample string 9</Country>
<Line1>sample string 3</Line1>
<Line2>sample string 4</Line2>
<Line3>sample string 5</Line3>
<PostalCode>sample string 10</PostalCode>
<RoomNumber>sample string 13</RoomNumber>
<State>sample string 8</State>
<Zip>sample string 11</Zip>
<ZipPlusFour>sample string 12</ZipPlusFour>
</DefaultAddress>
<DefaultEmail>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">61bc3823-a36a-4e89-9c7f-28884299ac9e</Id>
<Address>sample string 1</Address>
<Description>sample string 2</Description>
</DefaultEmail>
<DefaultPhone>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">b4f930fa-8329-4868-97bf-e08aceaf68cf</Id>
<Description>sample string 4</Description>
<MessageDeviceType>sample string 1</MessageDeviceType>
<MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
<Number>sample string 3</Number>
</DefaultPhone>
<EmailList>
<Email>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">61bc3823-a36a-4e89-9c7f-28884299ac9e</Id>
<Address>sample string 1</Address>
<Description>sample string 2</Description>
</Email>
<Email>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">61bc3823-a36a-4e89-9c7f-28884299ac9e</Id>
<Address>sample string 1</Address>
<Description>sample string 2</Description>
</Email>
</EmailList>
<EnrollmentStatus>sample string 11</EnrollmentStatus>
<GradeUid>sample string 9</GradeUid>
<HomeRoom>sample string 10</HomeRoom>
<IsEnrolled>true</IsEnrolled>
<Locker>sample string 13</Locker>
<LockerCombination>sample string 14</LockerCombination>
<ParkingSpace>sample string 15</ParkingSpace>
<PhoneList>
<Phone>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">b4f930fa-8329-4868-97bf-e08aceaf68cf</Id>
<Description>sample string 4</Description>
<MessageDeviceType>sample string 1</MessageDeviceType>
<MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
<Number>sample string 3</Number>
</Phone>
<Phone>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">b4f930fa-8329-4868-97bf-e08aceaf68cf</Id>
<Description>sample string 4</Description>
<MessageDeviceType>sample string 1</MessageDeviceType>
<MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
<Number>sample string 3</Number>
</Phone>
</PhoneList>
<SIFRefId>c67d290d-b527-4ff3-bb4a-632bbca74baf</SIFRefId>
<SiteUid>sample string 8</SiteUid>
<StatePrId>sample string 2</StatePrId>
<StudentPerson>
<DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 22</DataVersion>
<Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">6f2ab952-5c6e-4f00-97f6-53498a998024</Id>
<AlternateFirstName>sample string 6</AlternateFirstName>
<AlternateLastName>sample string 7</AlternateLastName>
<AmericanIndian>true</AmericanIndian>
<Asian>true</Asian>
<BirthDate>2025-11-04T09:04:48.5176186-06:00</BirthDate>
<Black>true</Black>
<EmployerName>sample string 18</EmployerName>
<FirstName>sample string 2</FirstName>
<Gender>sample string 9</Gender>
<HispanicLatino>true</HispanicLatino>
<LanguageCodeDescription>sample string 20</LanguageCodeDescription>
<LanguageCodeUid>sample string 19</LanguageCodeUid>
<LastName>sample string 4</LastName>
<MiddleName>sample string 3</MiddleName>
<PacificIslander>true</PacificIslander>
<SSN>sample string 8</SSN>
<Suffix>sample string 5</Suffix>
<Title>sample string 1</Title>
<UnknownRace>true</UnknownRace>
<White>true</White>
</StudentPerson>
<StudentUid>sample string 1</StudentUid>
</Student>