POST api/SaveFormApplication

Request Information

URI Parameters

None.

Body Parameters

FormApplicationRequest
NameDescriptionTypeAdditional information
FormApplicationId

integer

None.

FormId

integer

None.

ScanOrder

integer

None.

ApplicationDate

date

None.

FormApplicationHistoryId

integer

None.

AcademicYearRegionId

integer

None.

LanguageCd

string

None.

FormApplicationNumber

string

None.

RegionId

integer

None.

BatchTypeId

integer

None.

FormOnlineUserId

integer

None.

RefuseBenefits

boolean

None.

EthnicityId

integer

None.

raceObjects

Collection of FormApplicationRacialandBenefitsModel

None.

benefitsModel

Collection of FormBenefitsModel

None.

CanShareInformation

boolean

None.

formApplicationHistoryRequest

FormApplicationHistoryRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "FormApplicationId": 1,
  "FormId": 1,
  "ScanOrder": 1,
  "ApplicationDate": "2026-04-21T10:00:26.5553028+00:00",
  "FormApplicationHistoryId": 2,
  "AcademicYearRegionId": 3,
  "LanguageCd": "sample string 4",
  "FormApplicationNumber": "sample string 5",
  "RegionId": 6,
  "BatchTypeId": 7,
  "FormOnlineUserId": 8,
  "RefuseBenefits": true,
  "EthnicityId": 1,
  "raceObjects": [
    {
      "RaceId": 1,
      "IsSelected": true,
      "OtherBenefitId": 1,
      "HasBenefits": true
    },
    {
      "RaceId": 1,
      "IsSelected": true,
      "OtherBenefitId": 1,
      "HasBenefits": true
    }
  ],
  "benefitsModel": [
    {
      "OtherBenefitId": 1,
      "BenefitDescription": "sample string 1",
      "HasBenefit": true
    },
    {
      "OtherBenefitId": 1,
      "BenefitDescription": "sample string 1",
      "HasBenefit": true
    }
  ],
  "CanShareInformation": true,
  "formApplicationHistoryRequest": {
    "FormApplicationHistoryId": 1,
    "FormApplicationId": 1,
    "FormApplicationStatusId": 1,
    "IncomeCollectionMethod": "sample string 2",
    "IncomeResponse": "sample string 3",
    "ApplicationEigStatus": "sample string 4",
    "CaseTypeId": 5,
    "CaseNumber": "sample string 6",
    "HouseholdSize": 7,
    "IncomePeriodCd": "sample string 8",
    "EligibilityGuidelineId": 9,
    "IncomeRangeId": 10,
    "TotalIncome": 11.0,
    "IsGreater": true,
    "EligibilityId": 13,
    "BasisId": 14,
    "UserId": "597c054f-14d1-40d0-b691-7497dd410087",
    "IPAddress": "sample string 16"
  }
}

application/xml, text/xml

Sample:
<FormApplicationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.FormApplication">
  <AcademicYearRegionId>3</AcademicYearRegionId>
  <ApplicationDate>2026-04-21T10:00:26.5553028+00:00</ApplicationDate>
  <BatchTypeId>7</BatchTypeId>
  <CanShareInformation>true</CanShareInformation>
  <EthnicityId>1</EthnicityId>
  <FormApplicationHistoryId>2</FormApplicationHistoryId>
  <FormApplicationId>1</FormApplicationId>
  <FormApplicationNumber>sample string 5</FormApplicationNumber>
  <FormId>1</FormId>
  <FormOnlineUserId>8</FormOnlineUserId>
  <LanguageCd>sample string 4</LanguageCd>
  <RefuseBenefits>true</RefuseBenefits>
  <RegionId>6</RegionId>
  <ScanOrder>1</ScanOrder>
  <benefitsModel>
    <FormBenefitsModel>
      <BenefitDescription>sample string 1</BenefitDescription>
      <HasBenefit>true</HasBenefit>
      <OtherBenefitId>1</OtherBenefitId>
    </FormBenefitsModel>
    <FormBenefitsModel>
      <BenefitDescription>sample string 1</BenefitDescription>
      <HasBenefit>true</HasBenefit>
      <OtherBenefitId>1</OtherBenefitId>
    </FormBenefitsModel>
  </benefitsModel>
  <formApplicationHistoryRequest>
    <ApplicationEigStatus>sample string 4</ApplicationEigStatus>
    <BasisId>14</BasisId>
    <CaseNumber>sample string 6</CaseNumber>
    <CaseTypeId>5</CaseTypeId>
    <EligibilityGuidelineId>9</EligibilityGuidelineId>
    <EligibilityId>13</EligibilityId>
    <FormApplicationHistoryId>1</FormApplicationHistoryId>
    <FormApplicationId>1</FormApplicationId>
    <FormApplicationStatusId>1</FormApplicationStatusId>
    <HouseholdSize>7</HouseholdSize>
    <IPAddress>sample string 16</IPAddress>
    <IncomeCollectionMethod>sample string 2</IncomeCollectionMethod>
    <IncomePeriodCd>sample string 8</IncomePeriodCd>
    <IncomeRangeId>10</IncomeRangeId>
    <IncomeResponse>sample string 3</IncomeResponse>
    <IsGreater>true</IsGreater>
    <TotalIncome>11</TotalIncome>
    <UserId>597c054f-14d1-40d0-b691-7497dd410087</UserId>
  </formApplicationHistoryRequest>
  <raceObjects>
    <FormApplicationRacialandBenefitsModel>
      <HasBenefits>true</HasBenefits>
      <IsSelected>true</IsSelected>
      <OtherBenefitId>1</OtherBenefitId>
      <RaceId>1</RaceId>
    </FormApplicationRacialandBenefitsModel>
    <FormApplicationRacialandBenefitsModel>
      <HasBenefits>true</HasBenefits>
      <IsSelected>true</IsSelected>
      <OtherBenefitId>1</OtherBenefitId>
      <RaceId>1</RaceId>
    </FormApplicationRacialandBenefitsModel>
  </raceObjects>
</FormApplicationRequest>

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

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>