GET api/Incentives/GetPage?page={page}&perpage={perpage}&parentid={parentid}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
page

integer

Required

perpage

integer

Required

parentid

integer

None.

Body Parameters

None.

Response Information

Resource Description

PageContainerOfIncentive
NameDescriptionTypeAdditional information
Count

integer

None.

List

Collection of Incentive

None.

Response Formats

application/json, text/json

Sample:
{
  "Count": 1,
  "List": [
    {
      "IncentiveId": 1,
      "Name": "sample string 2",
      "Type": "sample string 3",
      "Program": "sample string 4",
      "Category": "sample string 5",
      "Keyword": "sample string 6",
      "FuelSource": "sample string 7",
      "Detail": "sample string 8",
      "Eligibility": "sample string 9",
      "Utility": "sample string 10",
      "Amount": "sample string 11",
      "URL": "sample string 12",
      "PhoneEmail": "sample string 13",
      "UtilityType": "sample string 14",
      "Zipcodes": [
        {
          "Code": "sample string 1",
          "Location": "sample string 2",
          "Id": 3,
          "ModifiedDate": "2025-05-30T21:32:59.4538062-04:00",
          "CreatedDate": "2025-05-30T21:32:59.4538062-04:00",
          "Disabled": true
        },
        {
          "Code": "sample string 1",
          "Location": "sample string 2",
          "Id": 3,
          "ModifiedDate": "2025-05-30T21:32:59.4538062-04:00",
          "CreatedDate": "2025-05-30T21:32:59.4538062-04:00",
          "Disabled": true
        }
      ],
      "Id": 15,
      "ModifiedDate": "2025-05-30T21:32:59.4538062-04:00",
      "CreatedDate": "2025-05-30T21:32:59.4538062-04:00",
      "Disabled": true
    },
    {
      "IncentiveId": 1,
      "Name": "sample string 2",
      "Type": "sample string 3",
      "Program": "sample string 4",
      "Category": "sample string 5",
      "Keyword": "sample string 6",
      "FuelSource": "sample string 7",
      "Detail": "sample string 8",
      "Eligibility": "sample string 9",
      "Utility": "sample string 10",
      "Amount": "sample string 11",
      "URL": "sample string 12",
      "PhoneEmail": "sample string 13",
      "UtilityType": "sample string 14",
      "Zipcodes": [
        {
          "Code": "sample string 1",
          "Location": "sample string 2",
          "Id": 3,
          "ModifiedDate": "2025-05-30T21:32:59.4538062-04:00",
          "CreatedDate": "2025-05-30T21:32:59.4538062-04:00",
          "Disabled": true
        },
        {
          "Code": "sample string 1",
          "Location": "sample string 2",
          "Id": 3,
          "ModifiedDate": "2025-05-30T21:32:59.4538062-04:00",
          "CreatedDate": "2025-05-30T21:32:59.4538062-04:00",
          "Disabled": true
        }
      ],
      "Id": 15,
      "ModifiedDate": "2025-05-30T21:32:59.4538062-04:00",
      "CreatedDate": "2025-05-30T21:32:59.4538062-04:00",
      "Disabled": true
    }
  ]
}

text/xml

Sample:
<PageContainerOfIncentiveE7HY1ukH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Domain.Core">
  <Count>1</Count>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Incentive">
    <d2p1:Incentive>
      <CreatedDate>2025-05-30T21:32:59.4538062-04:00</CreatedDate>
      <Disabled>true</Disabled>
      <Id>15</Id>
      <ModifiedDate>2025-05-30T21:32:59.4538062-04:00</ModifiedDate>
      <d2p1:Amount>sample string 11</d2p1:Amount>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:Detail>sample string 8</d2p1:Detail>
      <d2p1:Eligibility>sample string 9</d2p1:Eligibility>
      <d2p1:FuelSource>sample string 7</d2p1:FuelSource>
      <d2p1:IncentiveId>1</d2p1:IncentiveId>
      <d2p1:Keyword>sample string 6</d2p1:Keyword>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:PhoneEmail>sample string 13</d2p1:PhoneEmail>
      <d2p1:Program>sample string 4</d2p1:Program>
      <d2p1:Type>sample string 3</d2p1:Type>
      <d2p1:URL>sample string 12</d2p1:URL>
      <d2p1:Utility>sample string 10</d2p1:Utility>
      <d2p1:UtilityType>sample string 14</d2p1:UtilityType>
      <d2p1:Zipcodes xmlns:d4p1="http://schemas.datacontract.org/2004/07/Domain.Zipcode">
        <d4p1:Zipcode>
          <CreatedDate>2025-05-30T21:32:59.4538062-04:00</CreatedDate>
          <Disabled>true</Disabled>
          <Id>3</Id>
          <ModifiedDate>2025-05-30T21:32:59.4538062-04:00</ModifiedDate>
          <d4p1:Code>sample string 1</d4p1:Code>
          <d4p1:Location>sample string 2</d4p1:Location>
        </d4p1:Zipcode>
        <d4p1:Zipcode>
          <CreatedDate>2025-05-30T21:32:59.4538062-04:00</CreatedDate>
          <Disabled>true</Disabled>
          <Id>3</Id>
          <ModifiedDate>2025-05-30T21:32:59.4538062-04:00</ModifiedDate>
          <d4p1:Code>sample string 1</d4p1:Code>
          <d4p1:Location>sample string 2</d4p1:Location>
        </d4p1:Zipcode>
      </d2p1:Zipcodes>
    </d2p1:Incentive>
    <d2p1:Incentive>
      <CreatedDate>2025-05-30T21:32:59.4538062-04:00</CreatedDate>
      <Disabled>true</Disabled>
      <Id>15</Id>
      <ModifiedDate>2025-05-30T21:32:59.4538062-04:00</ModifiedDate>
      <d2p1:Amount>sample string 11</d2p1:Amount>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:Detail>sample string 8</d2p1:Detail>
      <d2p1:Eligibility>sample string 9</d2p1:Eligibility>
      <d2p1:FuelSource>sample string 7</d2p1:FuelSource>
      <d2p1:IncentiveId>1</d2p1:IncentiveId>
      <d2p1:Keyword>sample string 6</d2p1:Keyword>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:PhoneEmail>sample string 13</d2p1:PhoneEmail>
      <d2p1:Program>sample string 4</d2p1:Program>
      <d2p1:Type>sample string 3</d2p1:Type>
      <d2p1:URL>sample string 12</d2p1:URL>
      <d2p1:Utility>sample string 10</d2p1:Utility>
      <d2p1:UtilityType>sample string 14</d2p1:UtilityType>
      <d2p1:Zipcodes xmlns:d4p1="http://schemas.datacontract.org/2004/07/Domain.Zipcode">
        <d4p1:Zipcode>
          <CreatedDate>2025-05-30T21:32:59.4538062-04:00</CreatedDate>
          <Disabled>true</Disabled>
          <Id>3</Id>
          <ModifiedDate>2025-05-30T21:32:59.4538062-04:00</ModifiedDate>
          <d4p1:Code>sample string 1</d4p1:Code>
          <d4p1:Location>sample string 2</d4p1:Location>
        </d4p1:Zipcode>
        <d4p1:Zipcode>
          <CreatedDate>2025-05-30T21:32:59.4538062-04:00</CreatedDate>
          <Disabled>true</Disabled>
          <Id>3</Id>
          <ModifiedDate>2025-05-30T21:32:59.4538062-04:00</ModifiedDate>
          <d4p1:Code>sample string 1</d4p1:Code>
          <d4p1:Location>sample string 2</d4p1:Location>
        </d4p1:Zipcode>
      </d2p1:Zipcodes>
    </d2p1:Incentive>
  </List>
</PageContainerOfIncentiveE7HY1ukH>