PUT request/customer/{CustomerId}/site/{SiteId}/meter/gas/{MeterId}

Updates gas meter details for a customer site.

Request Information

URI Parameters

Name	Type	Additional information
CustomerId	integer	Required
MeterId	integer	Required
SiteId	integer	Required

Body Parameters

GasMeterPUT

Name	Type	Additional information
AnnualConsumption	integer	None.
AnnualConsumptionEfd	string	None.
AnnualConsumptionQualityIndicator	string	None.
availableSupplyCapacity	decimal number	None.
Commission	decimal number	None.
ComparisionTypeId	integer	None.
Comparison	boolean	None.
ConnectionType	string	None.
ConsumerType	string	None.
Consumption	integer	None.
ConsumptionPeriodId	integer	None.
CurrentContractEndDate	date	None.
DomesticConsumerIndicator	string	None.
EnergyDirection	string	None.
existingArrangement	DcDaMeterDetails	None.
ExitZone	string	None.
GSPGroupId	string	None.
Included	boolean	None.
IndustryAnnualConsumption	string	None.
IndustryAnnualConsumptionEfd	string	None.
IndustryCurrentSupplierMPID	string	None.
IndustryCurrentSupplierName	string	None.
IndustryMeterType	string	None.
IndustryMeterTypeDescription	string	None.
IndustrySupplierEFDate	string	None.
IsAmr	byte	None.
IsCommisionFromCustomer	boolean	None.
IsCommisionFromSite	boolean	None.
IsImport	boolean	None.
IsIndustryUpdateRequired	boolean	None.
lastMeterReadType	string	None.
lastMeterReadTypeDescription	string	None.
ldzId	string	None.
MeterSerialNumber	string	None.
MeterStatus	string	None.
MeterTimeswitchCode	integer	None.
meterVoltage	string	None.
MPRN	string	None.
MPRNOverwritten	boolean	None.
OutOfContract	boolean	None.
PreferredContractEndDate	date	None.
PreferredContractStartDate	date	None.
RelationshipStatusIndicator	string	None.
StandingCharge	decimal number	None.
StandingChargePeriodId	integer	None.
SupplierEFDate	string	None.
SupplierId	integer	None.
Type	string	None.
UnitRate	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "supplierId": 1,
  "mprn": "sample string 1",
  "mprnOverwritten": true,
  "isAmr": 64,
  "standingCharge": 1.0,
  "unitRate": 1.0,
  "consumption": 1,
  "comparisionTypeId": 4,
  "standingChargePeriodId": 5,
  "consumptionPeriodId": 6,
  "currentContractEndDate": "2026-08-05T04:23:30.1927738+00:00",
  "preferredContractStartDate": "2026-08-05T04:23:30.1927738+00:00",
  "preferredContractEndDate": "2026-08-05T04:23:30.1927738+00:00",
  "isCommisionFromCustomer": true,
  "isCommisionFromSite": true,
  "commission": 1.0,
  "meterVoltage": "sample string 7",
  "availableSupplyCapacity": 1.0,
  "outOfContract": true,
  "comparison": true,
  "type": "sample string 10",
  "included": true,
  "meterSerialNumber": "sample string 12",
  "isImport": true,
  "existingArrangement": {
    "dcda": {
      "hasExistingArrangement": true,
      "providerName": "sample string 1",
      "startEndDate": "2026-08-05T04:23:30.1927738+00:00"
    },
    "mop": {
      "hasExistingArrangement": true,
      "providerName": "sample string 1",
      "startEndDate": "2026-08-05T04:23:30.1927738+00:00"
    },
    "meterConnectionTypeName": "sample string 1",
    "meterConnectionTypeId": 2
  },
  "meterTimeswitchCode": 1,
  "meterStatus": "sample string 13",
  "gspGroupId": "sample string 14",
  "exitZone": "sample string 15",
  "connectionType": "sample string 16",
  "energyDirection": "sample string 17",
  "industryAnnualConsumption": "sample string 18",
  "annualConsumptionQualityIndicator": "sample string 19",
  "annualConsumption": 1,
  "annualConsumptionEfd": "sample string 20",
  "lastMeterReadType": "sample string 21",
  "lastMeterReadTypeDescription": "sample string 22",
  "consumerType": "sample string 23",
  "domesticConsumerIndicator": "sample string 24",
  "relationshipStatusIndicator": "sample string 25",
  "supplierEFDate": "sample string 26",
  "industryMeterType": "sample string 27",
  "industryMeterTypeDescription": "sample string 28",
  "industryCurrentSupplierName": "sample string 29",
  "industryCurrentSupplierMPID": "sample string 30",
  "industrySupplierEFDate": "sample string 31",
  "industryAnnualConsumptionEfd": "sample string 32",
  "ldzId": "sample string 33",
  "isIndustryUpdateRequired": true
}

text/html

Sample:

{"supplierId":1,"mprn":"sample string 1","mprnOverwritten":true,"isAmr":64,"standingCharge":1.0,"unitRate":1.0,"consumption":1,"comparisionTypeId":4,"standingChargePeriodId":5,"consumptionPeriodId":6,"currentContractEndDate":"2026-08-05T04:23:30.1927738+00:00","preferredContractStartDate":"2026-08-05T04:23:30.1927738+00:00","preferredContractEndDate":"2026-08-05T04:23:30.1927738+00:00","isCommisionFromCustomer":true,"isCommisionFromSite":true,"commission":1.0,"meterVoltage":"sample string 7","availableSupplyCapacity":1.0,"outOfContract":true,"comparison":true,"type":"sample string 10","included":true,"meterSerialNumber":"sample string 12","isImport":true,"existingArrangement":{"dcda":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2026-08-05T04:23:30.1927738+00:00"},"mop":{"hasExistingArrangement":true,"providerName":"sample string 1","startEndDate":"2026-08-05T04:23:30.1927738+00:00"},"meterConnectionTypeName":"sample string 1","meterConnectionTypeId":2},"meterTimeswitchCode":1,"meterStatus":"sample string 13","gspGroupId":"sample string 14","exitZone":"sample string 15","connectionType":"sample string 16","energyDirection":"sample string 17","industryAnnualConsumption":"sample string 18","annualConsumptionQualityIndicator":"sample string 19","annualConsumption":1,"annualConsumptionEfd":"sample string 20","lastMeterReadType":"sample string 21","lastMeterReadTypeDescription":"sample string 22","consumerType":"sample string 23","domesticConsumerIndicator":"sample string 24","relationshipStatusIndicator":"sample string 25","supplierEFDate":"sample string 26","industryMeterType":"sample string 27","industryMeterTypeDescription":"sample string 28","industryCurrentSupplierName":"sample string 29","industryCurrentSupplierMPID":"sample string 30","industrySupplierEFDate":"sample string 31","industryAnnualConsumptionEfd":"sample string 32","ldzId":"sample string 33","isIndustryUpdateRequired":true}

application/xml, text/xml

Sample:

<GasMeterPUT xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.MeterDto">
  <AnnualConsumption>1</AnnualConsumption>
  <AnnualConsumptionEfd>sample string 20</AnnualConsumptionEfd>
  <AnnualConsumptionQualityIndicator>sample string 19</AnnualConsumptionQualityIndicator>
  <Commission>1</Commission>
  <ComparisionTypeId>4</ComparisionTypeId>
  <Comparison>true</Comparison>
  <ConnectionType>sample string 16</ConnectionType>
  <ConsumerType>sample string 23</ConsumerType>
  <Consumption>1</Consumption>
  <ConsumptionPeriodId>6</ConsumptionPeriodId>
  <CurrentContractEndDate>2026-08-05T04:23:30.1927738+00:00</CurrentContractEndDate>
  <DomesticConsumerIndicator>sample string 24</DomesticConsumerIndicator>
  <EnergyDirection>sample string 17</EnergyDirection>
  <ExitZone>sample string 15</ExitZone>
  <GSPGroupId>sample string 14</GSPGroupId>
  <Included>true</Included>
  <IndustryAnnualConsumption>sample string 18</IndustryAnnualConsumption>
  <IndustryAnnualConsumptionEfd>sample string 32</IndustryAnnualConsumptionEfd>
  <IndustryCurrentSupplierMPID>sample string 30</IndustryCurrentSupplierMPID>
  <IndustryCurrentSupplierName>sample string 29</IndustryCurrentSupplierName>
  <IndustryMeterType>sample string 27</IndustryMeterType>
  <IndustryMeterTypeDescription>sample string 28</IndustryMeterTypeDescription>
  <IndustrySupplierEFDate>sample string 31</IndustrySupplierEFDate>
  <IsAmr>64</IsAmr>
  <IsCommisionFromCustomer>true</IsCommisionFromCustomer>
  <IsCommisionFromSite>true</IsCommisionFromSite>
  <IsImport>true</IsImport>
  <IsIndustryUpdateRequired>true</IsIndustryUpdateRequired>
  <MPRN>sample string 1</MPRN>
  <MPRNOverwritten>true</MPRNOverwritten>
  <MeterSerialNumber>sample string 12</MeterSerialNumber>
  <MeterStatus>sample string 13</MeterStatus>
  <MeterTimeswitchCode>1</MeterTimeswitchCode>
  <OutOfContract>true</OutOfContract>
  <PreferredContractEndDate>2026-08-05T04:23:30.1927738+00:00</PreferredContractEndDate>
  <PreferredContractStartDate>2026-08-05T04:23:30.1927738+00:00</PreferredContractStartDate>
  <RelationshipStatusIndicator>sample string 25</RelationshipStatusIndicator>
  <StandingCharge>1</StandingCharge>
  <StandingChargePeriodId>5</StandingChargePeriodId>
  <SupplierEFDate>sample string 26</SupplierEFDate>
  <SupplierId>1</SupplierId>
  <Type>sample string 10</Type>
  <UnitRate>1</UnitRate>
  <availableSupplyCapacity>1</availableSupplyCapacity>
  <existingArrangement>
    <MeterConnectionTypeId>2</MeterConnectionTypeId>
    <MeterConnectionTypeName>sample string 1</MeterConnectionTypeName>
    <dcda>
      <HasExistingArrangement>true</HasExistingArrangement>
      <ProviderName>sample string 1</ProviderName>
      <StartEndDate>2026-08-05T04:23:30.1927738+00:00</StartEndDate>
    </dcda>
    <mop>
      <HasExistingArrangement>true</HasExistingArrangement>
      <ProviderName>sample string 1</ProviderName>
      <StartEndDate>2026-08-05T04:23:30.1927738+00:00</StartEndDate>
    </mop>
  </existingArrangement>
  <lastMeterReadType>sample string 21</lastMeterReadType>
  <lastMeterReadTypeDescription>sample string 22</lastMeterReadTypeDescription>
  <ldzId>sample string 33</ldzId>
  <meterVoltage>sample string 7</meterVoltage>
</GasMeterPUT>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.