GET request/customer/{CustomerId}/site/{SiteId}/meter/gas/{MeterId}
Display Customer Site's specific Gas meter information
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerId | integer |
Required |
|
| MeterId | integer |
Required |
|
| SiteId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ElectricMeterView| Name | Description | Type | Additional information |
|---|---|---|---|
| AnnualValue | decimal number |
None. |
|
| availableSupplyCapacity | decimal number |
None. |
|
| Commission | decimal number |
None. |
|
| Comparison | boolean |
None. |
|
| ConsumptionPeriodId | integer |
None. |
|
| CurrentContractEndDate | date |
None. |
|
| CustomerId | integer |
None. |
|
| DateCreated | date |
None. |
|
| DateModified | date |
None. |
|
| existingArrangement | DcDaMeterDetails |
None. |
|
| Included | boolean |
None. |
|
| IsAmr | byte |
None. |
|
| IsCommisionFromCustomer | boolean |
None. |
|
| IsCommisionFromSite | boolean |
None. |
|
| IsImport | boolean |
None. |
|
| IsinBespokeQuote | boolean |
None. |
|
| MeterId | integer |
None. |
|
| MeterSerialNumber | string |
None. |
|
| meterVoltage | string |
None. |
|
| MPAN | string |
None. |
|
| MPANOverwritten | boolean |
None. |
|
| NightUnitRate | decimal number |
None. |
|
| NightUsage | integer |
None. |
|
| OutOfContract | boolean |
None. |
|
| PreferredContractEndDate | date |
None. |
|
| PreferredContractStartDate | date |
None. |
|
| rateNames | RateNames |
None. |
|
| RateType | RateType |
None. |
|
| SiteId | integer |
None. |
|
| StandardSettlementCode | integer |
None. |
|
| StandingCharge | decimal number |
None. |
|
| StandingChargePeriodId | integer |
None. |
|
| SupplierId | integer |
None. |
|
| Type | string |
None. |
|
| UnitRate | decimal number |
None. |
|
| Usage | integer |
None. |
|
| WeekendUnitRate | decimal number |
None. |
|
| WeekendUsage | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"siteId": 1,
"meterId": 2,
"customerId": 3,
"annualValue": 1.0,
"dateCreated": "2025-11-05T12:22:32.5884158+00:00",
"dateModified": "2025-11-05T12:22:32.5884158+00:00",
"isinBespokeQuote": true,
"supplierId": 1,
"mpan": "sample string 6",
"mpanOverwritten": true,
"isAmr": 64,
"standingCharge": 1.0,
"unitRate": 1.0,
"usage": 1,
"nightUnitRate": 1.0,
"nightUsage": 1,
"weekendUnitRate": 1.0,
"weekendUsage": 1,
"standingChargePeriodId": 9,
"consumptionPeriodId": 10,
"currentContractEndDate": "2025-11-05T12:22:32.5884158+00:00",
"preferredContractStartDate": "2025-11-05T12:22:32.5884158+00:00",
"preferredContractEndDate": "2025-11-05T12:22:32.5884158+00:00",
"isCommisionFromCustomer": true,
"isCommisionFromSite": true,
"commission": 1.0,
"rateType": "Single",
"meterVoltage": "sample string 11",
"availableSupplyCapacity": 1.0,
"included": true,
"outOfContract": true,
"comparison": true,
"type": "sample string 15",
"standardSettlementCode": 16,
"rateNames": {
"unitRateName": "sample string 1",
"nightUnitRateName": "sample string 2",
"weekendUnitRateName": "sample string 3"
},
"meterSerialNumber": "sample string 17",
"isImport": true,
"existingArrangement": {
"dcda": {
"hasExistingArrangement": true,
"providerName": "sample string 1",
"startEndDate": "2025-11-05T12:22:32.5884158+00:00"
},
"mop": {
"hasExistingArrangement": true,
"providerName": "sample string 1",
"startEndDate": "2025-11-05T12:22:32.5884158+00:00"
},
"meterConnectionTypeName": "sample string 1",
"meterConnectionTypeId": 2
}
}
text/html
Sample:
{"siteId":1,"meterId":2,"customerId":3,"annualValue":1.0,"dateCreated":"2025-11-05T12:22:32.5884158+00:00","dateModified":"2025-11-05T12:22:32.5884158+00:00","isinBespokeQuote":true,"supplierId":1,"mpan":"sample string 6","mpanOverwritten":true,"isAmr":64,"standingCharge":1.0,"unitRate":1.0,"usage":1,"nightUnitRate":1.0,"nightUsage":1,"weekendUnitRate":1.0,"weekendUsage":1,"standingChargePeriodId":9,"consumptionPeriodId":10,"currentContractEndDate":"2025-11-05T12:22:32.5884158+00:00","preferredContractStartDate":"2025-11-05T12:22:32.5884158+00:00","preferredContractEndDate":"2025-11-05T12:22:32.5884158+00:00","isCommisionFromCustomer":true,"isCommisionFromSite":true,"commission":1.0,"rateType":"Single","meterVoltage":"sample string 11","availableSupplyCapacity":1.0,"included":true,"outOfContract":true,"comparison":true,"type":"sample string 15","standardSettlementCode":16,"rateNames":{"unitRateName":"sample string 1","nightUnitRateName":"sample string 2","weekendUnitRateName":"sample string 3"},"meterSerialNumber":"sample string 17","isImport":true,"existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-11-05T12:22:32.5884158+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2025-11-05T12:22:32.5884158+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2}}
application/xml, text/xml
Sample:
<ElectricMeterView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.MeterDto">
<Commission>1</Commission>
<Comparison>true</Comparison>
<ConsumptionPeriodId>10</ConsumptionPeriodId>
<CurrentContractEndDate>2025-11-05T12:22:32.5884158+00:00</CurrentContractEndDate>
<Included>true</Included>
<IsAmr>64</IsAmr>
<IsCommisionFromCustomer>true</IsCommisionFromCustomer>
<IsCommisionFromSite>true</IsCommisionFromSite>
<IsImport>true</IsImport>
<MPAN>sample string 6</MPAN>
<MPANOverwritten>true</MPANOverwritten>
<MeterSerialNumber>sample string 17</MeterSerialNumber>
<NightUnitRate>1</NightUnitRate>
<NightUsage>1</NightUsage>
<OutOfContract>true</OutOfContract>
<PreferredContractEndDate>2025-11-05T12:22:32.5884158+00:00</PreferredContractEndDate>
<PreferredContractStartDate>2025-11-05T12:22:32.5884158+00:00</PreferredContractStartDate>
<RateType>Single</RateType>
<StandardSettlementCode>16</StandardSettlementCode>
<StandingCharge>1</StandingCharge>
<StandingChargePeriodId>9</StandingChargePeriodId>
<SupplierId>1</SupplierId>
<Type>sample string 15</Type>
<UnitRate>1</UnitRate>
<Usage>1</Usage>
<WeekendUnitRate>1</WeekendUnitRate>
<WeekendUsage>1</WeekendUsage>
<availableSupplyCapacity>1</availableSupplyCapacity>
<existingArrangement>
<MeterConnectionTypeId>2</MeterConnectionTypeId>
<MeterConnectionTypeName>sample string 1</MeterConnectionTypeName>
<dcda>
<HasExistingArrangement>true</HasExistingArrangement>
<ProviderName>sample string 1</ProviderName>
<StartEndDate>2025-11-05T12:22:32.5884158+00:00</StartEndDate>
</dcda>
<mop>
<HasExistingArrangement>true</HasExistingArrangement>
<ProviderName>sample string 1</ProviderName>
<StartEndDate>2025-11-05T12:22:32.5884158+00:00</StartEndDate>
</mop>
</existingArrangement>
<meterVoltage>sample string 11</meterVoltage>
<rateNames>
<NightUnitRateName>sample string 2</NightUnitRateName>
<UnitRateName>sample string 1</UnitRateName>
<WeekendUnitRateName>sample string 3</WeekendUnitRateName>
</rateNames>
<AnnualValue>1</AnnualValue>
<CustomerId>3</CustomerId>
<DateCreated>2025-11-05T12:22:32.5884158+00:00</DateCreated>
<DateModified>2025-11-05T12:22:32.5884158+00:00</DateModified>
<IsinBespokeQuote>true</IsinBespokeQuote>
<MeterId>2</MeterId>
<SiteId>1</SiteId>
</ElectricMeterView>