GET api/Sites/{SiteId}/StudentFederal

Returns the Student Federal information for a Site.

Request Information

URI Parameters

Name	Description	Type	Additional information
SiteId	Application identifier for the Site	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of StudentFederal objects for the specified SiteId

Collection of StudentFederal

Name	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

Sample:

[
  {
    "StudentId": "97e592a5-b772-4587-a270-28d7a65df231",
    "FederalCodeUid": "sample string 2",
    "FederalCodeDescription": "sample string 3",
    "OtherCodeUid": "sample string 4",
    "OtherCodeDescription": "sample string 5",
    "BeginDate": "2025-04-26T00:11:58.3042032-05:00",
    "EndDate": "2025-04-26T00:11:58.3042032-05:00",
    "LastEffectiveDate": "2025-04-26T00:11:58.3042032-05:00",
    "Comment": "sample string 9",
    "Id": "d83dcac5-d93e-4ccb-bb3b-bce5a8b925fd",
    "DataVersion": "sample string 11",
    "ApiName": ""
  },
  {
    "StudentId": "97e592a5-b772-4587-a270-28d7a65df231",
    "FederalCodeUid": "sample string 2",
    "FederalCodeDescription": "sample string 3",
    "OtherCodeUid": "sample string 4",
    "OtherCodeDescription": "sample string 5",
    "BeginDate": "2025-04-26T00:11:58.3042032-05:00",
    "EndDate": "2025-04-26T00:11:58.3042032-05:00",
    "LastEffectiveDate": "2025-04-26T00:11:58.3042032-05:00",
    "Comment": "sample string 9",
    "Id": "d83dcac5-d93e-4ccb-bb3b-bce5a8b925fd",
    "DataVersion": "sample string 11",
    "ApiName": ""
  }
]

application/xml, text/xml

Sample:

<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">d83dcac5-d93e-4ccb-bb3b-bce5a8b925fd</Id>
    <BeginDate>2025-04-26T00:11:58.3042032-05:00</BeginDate>
    <Comment>sample string 9</Comment>
    <EndDate>2025-04-26T00:11:58.3042032-05:00</EndDate>
    <FederalCodeDescription>sample string 3</FederalCodeDescription>
    <FederalCodeUid>sample string 2</FederalCodeUid>
    <LastEffectiveDate>2025-04-26T00:11:58.3042032-05:00</LastEffectiveDate>
    <OtherCodeDescription>sample string 5</OtherCodeDescription>
    <OtherCodeUid>sample string 4</OtherCodeUid>
    <StudentId>97e592a5-b772-4587-a270-28d7a65df231</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">d83dcac5-d93e-4ccb-bb3b-bce5a8b925fd</Id>
    <BeginDate>2025-04-26T00:11:58.3042032-05:00</BeginDate>
    <Comment>sample string 9</Comment>
    <EndDate>2025-04-26T00:11:58.3042032-05:00</EndDate>
    <FederalCodeDescription>sample string 3</FederalCodeDescription>
    <FederalCodeUid>sample string 2</FederalCodeUid>
    <LastEffectiveDate>2025-04-26T00:11:58.3042032-05:00</LastEffectiveDate>
    <OtherCodeDescription>sample string 5</OtherCodeDescription>
    <OtherCodeUid>sample string 4</OtherCodeUid>
    <StudentId>97e592a5-b772-4587-a270-28d7a65df231</StudentId>
  </StudentFederal>
</ArrayOfStudentFederal>