GET api/StudentFederal/{StudentFederalId}

Returns a Student Federal.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
StudentFederalId

Application identifier for the Student Federal

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

StudentFederal object for the specified StudentFederalId

StudentFederal
NameDescriptionTypeAdditional 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

Sample: 
{
  "StudentId": "9044d413-7ffb-4e72-ac4a-3f4e50895bfa",
  "FederalCodeUid": "sample string 2",
  "FederalCodeDescription": "sample string 3",
  "OtherCodeUid": "sample string 4",
  "OtherCodeDescription": "sample string 5",
  "BeginDate": "2025-04-25T23:29:23.1103904-05:00",
  "EndDate": "2025-04-25T23:29:23.1103904-05:00",
  "LastEffectiveDate": "2025-04-25T23:29:23.1103904-05:00",
  "Comment": "sample string 9",
  "Id": "6e0cc004-0438-4793-b280-a764565e6008",
  "DataVersion": "sample string 11",
  "ApiName": ""
}

application/xml, text/xml

Sample: 
<StudentFederal 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 11</DataVersion>
  <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">6e0cc004-0438-4793-b280-a764565e6008</Id>
  <BeginDate>2025-04-25T23:29:23.1103904-05:00</BeginDate>
  <Comment>sample string 9</Comment>
  <EndDate>2025-04-25T23:29:23.1103904-05:00</EndDate>
  <FederalCodeDescription>sample string 3</FederalCodeDescription>
  <FederalCodeUid>sample string 2</FederalCodeUid>
  <LastEffectiveDate>2025-04-25T23:29:23.1103904-05:00</LastEffectiveDate>
  <OtherCodeDescription>sample string 5</OtherCodeDescription>
  <OtherCodeUid>sample string 4</OtherCodeUid>
  <StudentId>9044d413-7ffb-4e72-ac4a-3f4e50895bfa</StudentId>
</StudentFederal>