Transaction types
ProvideMeterDataRequest
Purpose |
Transaction Group |
Version |
Use |
---|---|---|---|
An Initiator can commence the Provide Meter Data Request if they require:
|
MTRD |
r9 |
optional |
Business field |
Restrictions |
aseXML |
schema |
---|---|---|---|
MeterDataVerifyRequest |
MeterDataVerifyRequest |
MeterDataManagement_r36 |
|
InitiatorRole |
Mandatory |
InitiatingTransactionID/TransactionIdentifier |
Transactions_r38 |
RequestID |
Mandatory |
TransactionID/TransactionIdentifier |
Transactions_r38 |
NMI |
Mandatory |
VerifyRequestData/NMITransactionBase/NMI |
Common_r41 |
NMIChecksum |
Optional |
Common_r41 |
|
StartReadDate |
Mandatory, xsd:date (ccyymmdd) |
CSVDataWithName |
Common_r41 |
EndReadDate |
Optional, xsd:date (ccyymmdd) |
CSVDataWithName |
Common_r41 |
MeterDataVerifyRequest
Purpose |
Transaction Group |
Version |
Use |
---|---|---|---|
Initiator queries MDFF data to ensure they have the latest version. Normally, after a ProvideMeterDataRequest.a |
MTRD |
r9 |
optional |
Field |
Restrictions |
aseXML |
schema |
---|---|---|---|
MeterDataVerifyRequest |
MeterDataVerifyRequest |
MeterDataManagement_r36 |
|
InitiatorRole |
Mandatory |
InitiatingTransactionID/TransactionIdentifier |
Transactions_r38 |
RequestID |
Mandatory |
TransactionID/TransactionIdentifier |
Transactions_r38 |
NMI |
Mandatory |
VerifyRequestData/NMITransactionBase/NMI |
Common_r41 |
NMIChecksum |
Optional |
Common_r41 |
|
NMIConfiguration |
Not relevant or Mandatory If provided, enter the expected NMIConfiguration or perceived problem in the InvestigationDescription field. See B2B Procedure: Meter Data Process. |
Electricity_r41 |
|
MeterSerial |
Not relevant or Mandatory Only required if the queried data is at the single meter level or an individual Datastream level. See B2B Procedure: Meter Data Process. |
MeterDataManagement_r36 |
|
NMISuffix |
Not relevant or Mandatory See B2B Procedure: Meter Data Process. |
Electricity_r4136 |
|
RegisterID |
Optional. Provided where the queried data relates to a single RegisterID or if a CurrentRead is provided. |
Electricity_r41 |
|
CurrentRead |
Not relevant for interval data Not relevant or Mandatory for accumulation meters if any of the following InvestigationCodes are used:
If populated, the NMISuffix must be populated and the RegisterID may be populated. Original Meter Reading provided in the MDFF data being queried. xsd:string 15 chars |
CSVDataWithName |
Common_r41 |
CurrentReadDate |
Not relevant for interval data Not relevant or Mandatory for accumulation meters if CurrentRead is populated. xsd:date (ccyymmdd) |
CSVDataWithName |
Common_r41 |
CurrentConsumption |
Not relevant for interval data Mandatory for accumulation meters if CurrentRead is populated. Original consumption figure (in kWh) in the MDFF queried data. |
CSVDataWithName |
Common_r41 |
StartReadDate |
Mandatory, xsd:date (ccyymmdd) |
CSVDataWithName |
Common_r41 |
EndReadDate |
Optional, xsd:date (ccyymmdd) |
CSVDataWithName |
Common_r41 |
InvestigationCode |
Mandatory |
ElectricityEnumerations |
|
InvestigationDescription |
Mandatory, xsd:string 240 chars Free text to assist the investigation. Specify the Meter Reading, the period, and the description of the problem. |
MeterDataManagement_r36 |
|
version |
type="r9" use="optional" default="r9" |
attribute |
MeterDataManagement_r36 |
MeterDataNotification
Purpose |
Transaction Group |
Version |
Use |
---|---|---|---|
Provide MDFF data to an MDP. |
MTRD |
r_25 |
optional |
Business field |
Restrictions |
aseXML |
Schema |
---|---|---|---|
MeterDataNotification |
Only CSVConsumptionData or CSVIntervalData used. You can only deliver one type of meter data within a transaction. |
MeterDataManagement_r36 |
|
RecipientRole |
Mandatory |
Common_r41 |
|
RequestID |
Not relevant or Mandatory Not relevant if sent as part of the normal Meter Data Notification Process. Mandatory if sent to the requesting Initiator as a response to a ProvideMeterDataRequest, VerifyMeterDataRequest or RemoteServiceRequest. |
MeterDataManagement_r36 |
|
CSVConsumptionData |
Required, nillable="true" Standard MDFF file format with data for Accumulation Meters only, not Interval Meter data or a mixture of the two. |
MeterDataManagement_r36 |
|
CSVIntervalData |
Required Standard MDFF file format with data for Interval Meters only, not Accumulation Meter data or a mixture of the two. |
Common_r41 |
MeterDataMissingNotification
Purpose |
Transaction Group |
Version |
Use |
---|---|---|---|
Requests the latest MDFF data held by the Recipient |
MTRD |
r14 |
optional |
Business field |
Restrictions |
aseXML |
Schema |
---|---|---|---|
MeterDataMissingNotification |
MeterDataMissingNotification |
MeterDataManagement_r36 |
|
MissingMeterData |
element |
Common_r41 |
|
CSVMissingMeterData |
element |
Common_r41 |
RemoteServiceRequest
Purpose |
Transaction Group |
Version |
Use |
---|---|---|---|
Submit Remote Service Request details to the service provider. Used to remotely retrieve information for:
|
MRSR |
r36 |
optional |
Business field |
Restrictions |
aseXML |
Schema |
---|---|---|---|
RemoteServiceRequest |
Prior to commencing the Remote Service Process, the Initiator and Recipient must agree the scope of the service(s) and the format of the response to the service request. |
MeterDataManagement_r36 |
|
RequestID |
Mandatory |
MeterDataManagement_r36 |
|
NMI |
Mandatory |
Common_r41 |
|
NMIChecksum |
Optional |
Common_r41 |
|
MeterSerialNumber |
Optional |
MeterDataManagement_r36 |
|
ServiceType |
Mandatory |
MeterDataManagement_r36 |
|
RequestCode |
Mandatory |
MeterDataManagement_r36 |
|
ResponseFormat |
Mandatory |
MeterDataManagement_r36 |
|
FromDateTime |
Optional, xsd:dateTime (ccyy-mm-ddThh:mm:ss.sss+hh:mm) |
CSVDataWithName |
Common_r41 |
ToDateTime |
Optional, xsd:dateTime (ccyy-mm-ddThh:mm:ss.sss+hh:mm) |
CSVDataWithName |
Common_r41 |
UserDef1… UserDef10 |
sequence |
MeterDataManagement_r36 |
RemoteServiceResponse
Purpose |
Transaction Group |
Version |
Use |
---|---|---|---|
Recipient responds to the Initiator with a Remote Service Response. |
MRSR |
r36 |
optional |
Business field |
Restrictions |
aseXML |
Schema |
---|---|---|---|
RemoteServiceResponse |
Prior to commencing the Remote Service Process, the Initiator and Recipient must agree the scope of the service(s) and the format of the response to the service request. |
MeterDataManagement_r36 |
|
RequestID |
Mandatory |
MeterDataManagement_r36 |
|
NMI |
Mandatory |
Common_r41 |
|
NMIChecksum |
Optional |
Common_r41 |
|
MeterSerialNumber |
Optional |
MeterDataManagement_r36 |
|
ServiceType |
Mandatory |
MeterDataManagement_r36 |
|
RequestCode |
Mandatory |
MeterDataManagement_r36 |
|
ResponseFormat |
Mandatory |
MeterDataManagement_r36 |
|
FromDateTime |
Optional, xsd:dateTime (ccyy-mm-ddThh:mm:ss.sss+hh:mm) |
CSVDataWithName |
Common_r41 |
ToDateTime |
Optional, xsd:dateTime (ccyy-mm-ddThh:mm:ss.sss+hh:mm) |
CSVDataWithName |
Common_r41 |
UserDef1… UserDef10 |
sequence |
MeterDataManagement_r36 |
|
ResponsePayload |
Optional |
MeterDataManagement_r36 |
|
ErrorCode |
Mandatory |
Events_r41 |
|
ErrorDescription |
Not relevant or Mandatory Mandatory when Error Code not equal to zero |
Events_r41 |
|
ProductCode |
Optional |
CustomerDetails_r41 |
BusinessAcceptance/Rejection for MDN not accepted
Business field |
Restrictions |
aseXML |
Schema |
---|---|---|---|
EventCode |
Mandatory See B2B Procedure: Meter Data Process |
Events_r41 |
|
KeyInfo |
Not relevant or Mandatory If populated with a number, it is the line number within the CSV data block where the event occurred. If the field is not populated, the EventCode refers to the aseXML transaction, not the CSV data. |
Events_r41 |
|
Context |
Not relevant or Mandatory |
Events_r41 |
|
Explanation |
Mandatory if the Business Event requires an explanation, otherwise optional xsd:string unlimited chars, minOccurs=”0” See B2B Procedure: Meter Data Process |
Explanation |
Events_r41 |
Meter Data BusinessAcceptance/Rejection
Business field |
Restrictions |
aseXML |
Schema |
---|---|---|---|
EventCode |
Mandatory |
Events_r41 |
|
KeyInfo |
Mandatory |
Events_r41 |
|
Status |
Mandatory |
Events_r41 |