POST api/SaveProgramApplication

Request Information

URI Parameters

None.

Body Parameters

ProgramApplicationRequest
NameDescriptionTypeAdditional information
ProgramApplicationId

integer

None.

ScanOrder

integer

None.

ProgramId

integer

None.

ApplicationDate

date

None.

ProgramApplicationHistoryId

integer

None.

AcademicYearRegionId

integer

None.

LanguageCd

string

None.

ProgramApplicationNumber

string

None.

ProgramOnlineUserId

integer

None.

RefuseBenefits

boolean

None.

EthnicityId

integer

None.

raceObjects

Collection of RacialModel

None.

CanShareInformation

boolean

None.

programApplicationHistoryRequest

ProgramApplicationHistoryRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "ProgramApplicationId": 1,
  "ScanOrder": 1,
  "ProgramId": 1,
  "ApplicationDate": "2025-12-06T03:50:19.9047001+00:00",
  "ProgramApplicationHistoryId": 2,
  "AcademicYearRegionId": 3,
  "LanguageCd": "sample string 4",
  "ProgramApplicationNumber": "sample string 5",
  "ProgramOnlineUserId": 6,
  "RefuseBenefits": true,
  "EthnicityId": 1,
  "raceObjects": [
    {
      "RaceId": 1,
      "IsSelected": true
    },
    {
      "RaceId": 1,
      "IsSelected": true
    }
  ],
  "CanShareInformation": true,
  "programApplicationHistoryRequest": {
    "ProgramApplicationHistoryId": 1,
    "ProgramApplicationId": 1,
    "ProgramApplicationStatusId": 1,
    "IncomeResponse": "sample string 2",
    "ApplicationEigStatus": "sample string 3",
    "CaseTypeId": 4,
    "CaseNumber": "sample string 5",
    "HouseholdSize": 6,
    "IncomePeriodCd": "sample string 7",
    "EligibilityGuidelineId": 8,
    "IncomeRangeId": 9,
    "TotalIncome": 10.0,
    "IsGreater": true,
    "EligibilityId": 12,
    "BasisId": 13,
    "UserId": "439722f4-fddf-487d-a8cd-5aa61898a234"
  }
}

application/xml, text/xml

Sample:
<ProgramApplicationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.ProgramApplication">
  <AcademicYearRegionId>3</AcademicYearRegionId>
  <ApplicationDate>2025-12-06T03:50:19.9047001+00:00</ApplicationDate>
  <CanShareInformation>true</CanShareInformation>
  <EthnicityId>1</EthnicityId>
  <LanguageCd>sample string 4</LanguageCd>
  <ProgramApplicationHistoryId>2</ProgramApplicationHistoryId>
  <ProgramApplicationId>1</ProgramApplicationId>
  <ProgramApplicationNumber>sample string 5</ProgramApplicationNumber>
  <ProgramId>1</ProgramId>
  <ProgramOnlineUserId>6</ProgramOnlineUserId>
  <RefuseBenefits>true</RefuseBenefits>
  <ScanOrder>1</ScanOrder>
  <programApplicationHistoryRequest>
    <ApplicationEigStatus>sample string 3</ApplicationEigStatus>
    <BasisId>13</BasisId>
    <CaseNumber>sample string 5</CaseNumber>
    <CaseTypeId>4</CaseTypeId>
    <EligibilityGuidelineId>8</EligibilityGuidelineId>
    <EligibilityId>12</EligibilityId>
    <HouseholdSize>6</HouseholdSize>
    <IncomePeriodCd>sample string 7</IncomePeriodCd>
    <IncomeRangeId>9</IncomeRangeId>
    <IncomeResponse>sample string 2</IncomeResponse>
    <IsGreater>true</IsGreater>
    <ProgramApplicationHistoryId>1</ProgramApplicationHistoryId>
    <ProgramApplicationId>1</ProgramApplicationId>
    <ProgramApplicationStatusId>1</ProgramApplicationStatusId>
    <TotalIncome>10</TotalIncome>
    <UserId>439722f4-fddf-487d-a8cd-5aa61898a234</UserId>
  </programApplicationHistoryRequest>
  <raceObjects>
    <RacialModel>
      <IsSelected>true</IsSelected>
      <RaceId>1</RaceId>
    </RacialModel>
    <RacialModel>
      <IsSelected>true</IsSelected>
      <RaceId>1</RaceId>
    </RacialModel>
  </raceObjects>
</ProgramApplicationRequest>

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 'ProgramApplicationRequest'.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>