GET api/CheckUtilityRiders?PropertyId={PropertyId}&BillDate={BillDate}&Usage={Usage}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PropertyId | integer |
Required |
|
BillDate | date |
Required |
|
Usage | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CheckUtilityRiderResultName | Description | Type | Additional information |
---|---|---|---|
Riders | Collection of UtilityRiderRate |
None. |
|
RidersTotal | decimal number |
None. |
|
EnergyCharge | decimal number |
None. |
|
CustomerCharge | decimal number |
None. |
|
TotalUtilityCharge | decimal number |
None. |
|
CostPerKWH | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{ "Riders": [ { "RiderId": 1, "LegacyRiderId": 2, "UtilityId": 3, "PropertyId": 4, "RiderName": "sample string 5", "RiderType": "sample string 6", "MinKwh": 7, "MaxKwh": 8, "RateBasis": "sample string 9", "RateSummer": 10.1, "RateWinter": 11.1, "RateType": "sample string 12", "StartDate": "2024-03-28T20:26:58.5136894+00:00", "EndDate": "2024-03-28T20:26:58.5136894+00:00", "Deleted": "sample string 13", "DateCreated": "2024-03-28T20:26:58.5136894+00:00", "DateUpdated": "2024-03-28T20:26:58.5136894+00:00", "CreatedBy": 16, "UpdatedBy": 17, "RiderAmount": 18.0, "EffectiveRate": 19.1 }, { "RiderId": 1, "LegacyRiderId": 2, "UtilityId": 3, "PropertyId": 4, "RiderName": "sample string 5", "RiderType": "sample string 6", "MinKwh": 7, "MaxKwh": 8, "RateBasis": "sample string 9", "RateSummer": 10.1, "RateWinter": 11.1, "RateType": "sample string 12", "StartDate": "2024-03-28T20:26:58.5136894+00:00", "EndDate": "2024-03-28T20:26:58.5136894+00:00", "Deleted": "sample string 13", "DateCreated": "2024-03-28T20:26:58.5136894+00:00", "DateUpdated": "2024-03-28T20:26:58.5136894+00:00", "CreatedBy": 16, "UpdatedBy": 17, "RiderAmount": 18.0, "EffectiveRate": 19.1 } ], "RidersTotal": 1.0, "EnergyCharge": 2.0, "CustomerCharge": 3.0, "TotalUtilityCharge": 4.0, "CostPerKWH": 5.0 }
application/xml, text/xml
Sample:
<CheckUtilityRiderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APL.Models"> <CostPerKWH>5</CostPerKWH> <CustomerCharge>3</CustomerCharge> <EnergyCharge>2</EnergyCharge> <Riders> <UtilityRiderRate> <CreatedBy>16</CreatedBy> <DateCreated>2024-03-28T20:26:58.5136894+00:00</DateCreated> <DateUpdated>2024-03-28T20:26:58.5136894+00:00</DateUpdated> <Deleted>sample string 13</Deleted> <EffectiveRate>19.1</EffectiveRate> <EndDate>2024-03-28T20:26:58.5136894+00:00</EndDate> <LegacyRiderId>2</LegacyRiderId> <MaxKwh>8</MaxKwh> <MinKwh>7</MinKwh> <PropertyId>4</PropertyId> <RateBasis>sample string 9</RateBasis> <RateSummer>10.1</RateSummer> <RateType>sample string 12</RateType> <RateWinter>11.1</RateWinter> <RiderAmount>18</RiderAmount> <RiderId>1</RiderId> <RiderName>sample string 5</RiderName> <RiderType>sample string 6</RiderType> <StartDate>2024-03-28T20:26:58.5136894+00:00</StartDate> <UpdatedBy>17</UpdatedBy> <UtilityId>3</UtilityId> </UtilityRiderRate> <UtilityRiderRate> <CreatedBy>16</CreatedBy> <DateCreated>2024-03-28T20:26:58.5136894+00:00</DateCreated> <DateUpdated>2024-03-28T20:26:58.5136894+00:00</DateUpdated> <Deleted>sample string 13</Deleted> <EffectiveRate>19.1</EffectiveRate> <EndDate>2024-03-28T20:26:58.5136894+00:00</EndDate> <LegacyRiderId>2</LegacyRiderId> <MaxKwh>8</MaxKwh> <MinKwh>7</MinKwh> <PropertyId>4</PropertyId> <RateBasis>sample string 9</RateBasis> <RateSummer>10.1</RateSummer> <RateType>sample string 12</RateType> <RateWinter>11.1</RateWinter> <RiderAmount>18</RiderAmount> <RiderId>1</RiderId> <RiderName>sample string 5</RiderName> <RiderType>sample string 6</RiderType> <StartDate>2024-03-28T20:26:58.5136894+00:00</StartDate> <UpdatedBy>17</UpdatedBy> <UtilityId>3</UtilityId> </UtilityRiderRate> </Riders> <RidersTotal>1</RidersTotal> <TotalUtilityCharge>4</TotalUtilityCharge> </CheckUtilityRiderResult>