POST api/ProgramPostStudent

Request Information

URI Parameters

None.

Body Parameters

Collection of ProgramStudentModel
NameDescriptionTypeAdditional information
ProgramApplicationStudentId

integer

None.
ProgramApplicationId

integer

None.
FirstName

string

None.
LastName

string

None.
MiddleName

string

None.
BirthDate

date

None.
StudentID

string

None.
SiteId

integer

None.
GradeId

integer

None.
LiveInHousehold

boolean

None.
ApplicationApprovalTypeId

integer

None.
HasIncome

boolean

None.
EthnicityCode

string

None.
RaceCode

string

None.
PFDCurrentYear

boolean

None.
PFDPrevYear

boolean

None.
PersonId

globally unique identifier

None.
ProgramApplicationHouseholdIncomeModel

Collection of ProgramApplicationHouseHoldIncomeModel

None.
isAdding

boolean

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "ProgramApplicationStudentId": 1,
    "ProgramApplicationId": 1,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "MiddleName": "sample string 3",
    "BirthDate": "2025-12-06T03:50:19.7204572+00:00",
    "StudentID": "sample string 4",
    "SiteId": 1,
    "GradeId": 1,
    "LiveInHousehold": true,
    "ApplicationApprovalTypeId": 1,
    "HasIncome": true,
    "EthnicityCode": "sample string 5",
    "RaceCode": "sample string 6",
    "PFDCurrentYear": true,
    "PFDPrevYear": true,
    "PersonId": "35ae5710-1dd0-4531-a395-6177974a0be9",
    "ProgramApplicationHouseholdIncomeModel": [
      {
        "ProgramApplicationHouseholdIncomeId": 1,
        "IncomeType": 1,
        "Amount": 1.0,
        "IncomePeriodCd": "sample string 1"
      },
      {
        "ProgramApplicationHouseholdIncomeId": 1,
        "IncomeType": 1,
        "Amount": 1.0,
        "IncomePeriodCd": "sample string 1"
      }
    ],
    "isAdding": true
  },
  {
    "ProgramApplicationStudentId": 1,
    "ProgramApplicationId": 1,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "MiddleName": "sample string 3",
    "BirthDate": "2025-12-06T03:50:19.7204572+00:00",
    "StudentID": "sample string 4",
    "SiteId": 1,
    "GradeId": 1,
    "LiveInHousehold": true,
    "ApplicationApprovalTypeId": 1,
    "HasIncome": true,
    "EthnicityCode": "sample string 5",
    "RaceCode": "sample string 6",
    "PFDCurrentYear": true,
    "PFDPrevYear": true,
    "PersonId": "35ae5710-1dd0-4531-a395-6177974a0be9",
    "ProgramApplicationHouseholdIncomeModel": [
      {
        "ProgramApplicationHouseholdIncomeId": 1,
        "IncomeType": 1,
        "Amount": 1.0,
        "IncomePeriodCd": "sample string 1"
      },
      {
        "ProgramApplicationHouseholdIncomeId": 1,
        "IncomeType": 1,
        "Amount": 1.0,
        "IncomePeriodCd": "sample string 1"
      }
    ],
    "isAdding": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfProgramStudentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Controllers.ProgramApplication">
  <ProgramStudentModel>
    <ApplicationApprovalTypeId>1</ApplicationApprovalTypeId>
    <BirthDate>2025-12-06T03:50:19.7204572+00:00</BirthDate>
    <EthnicityCode>sample string 5</EthnicityCode>
    <FirstName>sample string 1</FirstName>
    <GradeId>1</GradeId>
    <HasIncome>true</HasIncome>
    <LastName>sample string 2</LastName>
    <LiveInHousehold>true</LiveInHousehold>
    <MiddleName>sample string 3</MiddleName>
    <PFDCurrentYear>true</PFDCurrentYear>
    <PFDPrevYear>true</PFDPrevYear>
    <PersonId>35ae5710-1dd0-4531-a395-6177974a0be9</PersonId>
    <ProgramApplicationHouseholdIncomeModel>
      <ProgramApplicationHouseHoldIncomeModel>
        <Amount>1</Amount>
        <IncomePeriodCd>sample string 1</IncomePeriodCd>
        <IncomeType>1</IncomeType>
        <ProgramApplicationHouseholdIncomeId>1</ProgramApplicationHouseholdIncomeId>
      </ProgramApplicationHouseHoldIncomeModel>
      <ProgramApplicationHouseHoldIncomeModel>
        <Amount>1</Amount>
        <IncomePeriodCd>sample string 1</IncomePeriodCd>
        <IncomeType>1</IncomeType>
        <ProgramApplicationHouseholdIncomeId>1</ProgramApplicationHouseholdIncomeId>
      </ProgramApplicationHouseHoldIncomeModel>
    </ProgramApplicationHouseholdIncomeModel>
    <ProgramApplicationId>1</ProgramApplicationId>
    <ProgramApplicationStudentId>1</ProgramApplicationStudentId>
    <RaceCode>sample string 6</RaceCode>
    <SiteId>1</SiteId>
    <StudentID>sample string 4</StudentID>
    <isAdding>true</isAdding>
  </ProgramStudentModel>
  <ProgramStudentModel>
    <ApplicationApprovalTypeId>1</ApplicationApprovalTypeId>
    <BirthDate>2025-12-06T03:50:19.7204572+00:00</BirthDate>
    <EthnicityCode>sample string 5</EthnicityCode>
    <FirstName>sample string 1</FirstName>
    <GradeId>1</GradeId>
    <HasIncome>true</HasIncome>
    <LastName>sample string 2</LastName>
    <LiveInHousehold>true</LiveInHousehold>
    <MiddleName>sample string 3</MiddleName>
    <PFDCurrentYear>true</PFDCurrentYear>
    <PFDPrevYear>true</PFDPrevYear>
    <PersonId>35ae5710-1dd0-4531-a395-6177974a0be9</PersonId>
    <ProgramApplicationHouseholdIncomeModel>
      <ProgramApplicationHouseHoldIncomeModel>
        <Amount>1</Amount>
        <IncomePeriodCd>sample string 1</IncomePeriodCd>
        <IncomeType>1</IncomeType>
        <ProgramApplicationHouseholdIncomeId>1</ProgramApplicationHouseholdIncomeId>
      </ProgramApplicationHouseHoldIncomeModel>
      <ProgramApplicationHouseHoldIncomeModel>
        <Amount>1</Amount>
        <IncomePeriodCd>sample string 1</IncomePeriodCd>
        <IncomeType>1</IncomeType>
        <ProgramApplicationHouseholdIncomeId>1</ProgramApplicationHouseholdIncomeId>
      </ProgramApplicationHouseHoldIncomeModel>
    </ProgramApplicationHouseholdIncomeModel>
    <ProgramApplicationId>1</ProgramApplicationId>
    <ProgramApplicationStudentId>1</ProgramApplicationStudentId>
    <RaceCode>sample string 6</RaceCode>
    <SiteId>1</SiteId>
    <StudentID>sample string 4</StudentID>
    <isAdding>true</isAdding>
  </ProgramStudentModel>
</ArrayOfProgramStudentModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

JsonResponseModel
NameDescriptionTypeAdditional information
Id

integer

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<JsonResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models">
  <Id>1</Id>
  <Message>sample string 2</Message>
</JsonResponseModel>