GET api/GetIncomeRangeList?settingId={settingId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
settingId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of IncomeRangeResponse
NameDescriptionTypeAdditional information
IncomeRangeId

integer

None.
AcademicYearRegionId

integer

None.
IncomePeriodCd

string

None.
IncomeAmount

decimal number

None.
EligibilityGuidelineId

integer

None.
AcademicYearId

integer

None.
HouseholdSize

integer

None.
ReducedLimit

decimal number

None.
FreeLimit

decimal number

None.
StateId

integer

None.
academicYear

AcademicYearModel

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "IncomeRangeId": 1,
    "AcademicYearRegionId": 2,
    "IncomePeriodCd": "sample string 3",
    "IncomeAmount": 4.0,
    "EligibilityGuidelineId": 5,
    "AcademicYearId": 6,
    "HouseholdSize": 7,
    "ReducedLimit": 8.0,
    "FreeLimit": 9.0,
    "StateId": 10,
    "academicYear": {
      "AcademicYearId": 1,
      "Description": "sample string 1",
      "StartDate": "2025-12-06T03:48:57.6003357+00:00",
      "EndDate": "2025-12-06T03:48:57.6003357+00:00",
      "SubscriptionTerminalId": 1,
      "UpdateDate": "2025-12-06T03:48:57.6003357+00:00"
    }
  },
  {
    "IncomeRangeId": 1,
    "AcademicYearRegionId": 2,
    "IncomePeriodCd": "sample string 3",
    "IncomeAmount": 4.0,
    "EligibilityGuidelineId": 5,
    "AcademicYearId": 6,
    "HouseholdSize": 7,
    "ReducedLimit": 8.0,
    "FreeLimit": 9.0,
    "StateId": 10,
    "academicYear": {
      "AcademicYearId": 1,
      "Description": "sample string 1",
      "StartDate": "2025-12-06T03:48:57.6003357+00:00",
      "EndDate": "2025-12-06T03:48:57.6003357+00:00",
      "SubscriptionTerminalId": 1,
      "UpdateDate": "2025-12-06T03:48:57.6003357+00:00"
    }
  }
]

application/xml, text/xml

Sample: 
<ArrayOfIncomeRangeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.IncomeSurveys">
  <IncomeRangeResponse>
    <AcademicYearId>6</AcademicYearId>
    <AcademicYearRegionId>2</AcademicYearRegionId>
    <EligibilityGuidelineId>5</EligibilityGuidelineId>
    <FreeLimit>9</FreeLimit>
    <HouseholdSize>7</HouseholdSize>
    <IncomeAmount>4</IncomeAmount>
    <IncomePeriodCd>sample string 3</IncomePeriodCd>
    <IncomeRangeId>1</IncomeRangeId>
    <ReducedLimit>8</ReducedLimit>
    <StateId>10</StateId>
    <academicYear>
      <AcademicYearId>1</AcademicYearId>
      <Description>sample string 1</Description>
      <EndDate>2025-12-06T03:48:57.6003357+00:00</EndDate>
      <StartDate>2025-12-06T03:48:57.6003357+00:00</StartDate>
      <SubscriptionTerminalId>1</SubscriptionTerminalId>
      <UpdateDate>2025-12-06T03:48:57.6003357+00:00</UpdateDate>
    </academicYear>
  </IncomeRangeResponse>
  <IncomeRangeResponse>
    <AcademicYearId>6</AcademicYearId>
    <AcademicYearRegionId>2</AcademicYearRegionId>
    <EligibilityGuidelineId>5</EligibilityGuidelineId>
    <FreeLimit>9</FreeLimit>
    <HouseholdSize>7</HouseholdSize>
    <IncomeAmount>4</IncomeAmount>
    <IncomePeriodCd>sample string 3</IncomePeriodCd>
    <IncomeRangeId>1</IncomeRangeId>
    <ReducedLimit>8</ReducedLimit>
    <StateId>10</StateId>
    <academicYear>
      <AcademicYearId>1</AcademicYearId>
      <Description>sample string 1</Description>
      <EndDate>2025-12-06T03:48:57.6003357+00:00</EndDate>
      <StartDate>2025-12-06T03:48:57.6003357+00:00</StartDate>
      <SubscriptionTerminalId>1</SubscriptionTerminalId>
      <UpdateDate>2025-12-06T03:48:57.6003357+00:00</UpdateDate>
    </academicYear>
  </IncomeRangeResponse>
</ArrayOfIncomeRangeResponse>