GET api/Students/{SchoolYear}/{StudentId}/StudentFederal
Returns the Student Federal information for 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
Collection of StudentFederal objects for the specified SchoolYear and StudentId
Collection of StudentFederalName | Description | Type | Additional information |
---|---|---|---|
StudentId |
The application identifier for the Student. |
globally unique identifier |
None. |
FederalCodeUid |
The user identifier for the Federal Code. |
string |
None. |
FederalCodeDescription |
The description for the Federal Code. |
string |
None. |
OtherCodeUid |
The user identifier for the Other Code. |
string |
None. |
OtherCodeDescription |
The description for the Other Code. |
string |
None. |
BeginDate |
The begin date for the Federal Code. |
date |
None. |
EndDate |
The end date for the Federal Code. |
date |
None. |
LastEffectiveDate |
The last date the Student is effectively participating in the Federal Code. |
date |
None. |
Comment |
The comment for the Federal Code. |
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": "cfa17d0d-8464-4251-aafb-969b49ae8453", "FederalCodeUid": "sample string 2", "FederalCodeDescription": "sample string 3", "OtherCodeUid": "sample string 4", "OtherCodeDescription": "sample string 5", "BeginDate": "2025-06-15T02:22:43.4247553-05:00", "EndDate": "2025-06-15T02:22:43.4247553-05:00", "LastEffectiveDate": "2025-06-15T02:22:43.4247553-05:00", "Comment": "sample string 9", "Id": "32775f67-617f-40bd-aed5-c758a5417df5", "DataVersion": "sample string 11", "ApiName": "" }, { "StudentId": "cfa17d0d-8464-4251-aafb-969b49ae8453", "FederalCodeUid": "sample string 2", "FederalCodeDescription": "sample string 3", "OtherCodeUid": "sample string 4", "OtherCodeDescription": "sample string 5", "BeginDate": "2025-06-15T02:22:43.4247553-05:00", "EndDate": "2025-06-15T02:22:43.4247553-05:00", "LastEffectiveDate": "2025-06-15T02:22:43.4247553-05:00", "Comment": "sample string 9", "Id": "32775f67-617f-40bd-aed5-c758a5417df5", "DataVersion": "sample string 11", "ApiName": "" } ]
application/xml, text/xml
<ArrayOfStudentFederal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1"> <StudentFederal> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 11</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">32775f67-617f-40bd-aed5-c758a5417df5</Id> <BeginDate>2025-06-15T02:22:43.4247553-05:00</BeginDate> <Comment>sample string 9</Comment> <EndDate>2025-06-15T02:22:43.4247553-05:00</EndDate> <FederalCodeDescription>sample string 3</FederalCodeDescription> <FederalCodeUid>sample string 2</FederalCodeUid> <LastEffectiveDate>2025-06-15T02:22:43.4247553-05:00</LastEffectiveDate> <OtherCodeDescription>sample string 5</OtherCodeDescription> <OtherCodeUid>sample string 4</OtherCodeUid> <StudentId>cfa17d0d-8464-4251-aafb-969b49ae8453</StudentId> </StudentFederal> <StudentFederal> <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 11</DataVersion> <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">32775f67-617f-40bd-aed5-c758a5417df5</Id> <BeginDate>2025-06-15T02:22:43.4247553-05:00</BeginDate> <Comment>sample string 9</Comment> <EndDate>2025-06-15T02:22:43.4247553-05:00</EndDate> <FederalCodeDescription>sample string 3</FederalCodeDescription> <FederalCodeUid>sample string 2</FederalCodeUid> <LastEffectiveDate>2025-06-15T02:22:43.4247553-05:00</LastEffectiveDate> <OtherCodeDescription>sample string 5</OtherCodeDescription> <OtherCodeUid>sample string 4</OtherCodeUid> <StudentId>cfa17d0d-8464-4251-aafb-969b49ae8453</StudentId> </StudentFederal> </ArrayOfStudentFederal>