DH-1000 Accounting point information retrieval
POST method
Resource description | |||
|---|---|---|---|
Definition | Interface for requesting accounting point information | ||
Path parameters | |||
{function} | GetAccountingPointDataPost | ||
Query string parameters | |||
Name | Type | Obligation | Note |
{organisationUser} | String | Mandatory |
|
{meteringPointEAN} | String(18) | Mandatory |
|
{customerIdentification} | String(50) | Mandatory |
|
{ViewDate} | DateTime | Mandatory | For terminated contracts use ContractEndDate. For confirmed contracts use CurrentDateTime |
Validation rules | |||
The requesting party must have a valid agreement (sales/grid agreement or authorisation agreement) with the customer on the view date. | |||
Response | |||
Accounting point information | |||
Request example | |||
https://{hostname}/rest/FGR/GetAccountingPointDataPostContent of the posted message: {
"GetAccountingPointDataRequest": {
"organisationUser": "{organisationUser}",
"Filters": {
"meteringPointEAN": "{meteringPointEAN}",
"customerIdentification": "{customerIdentification}",
"ViewDate": "{ViewDate}"
}
}
} | |||
GET method
The GET method will be discontinued when version 2.6 is deployed.
Resource description | |||
|---|---|---|---|
Definition | Interface for requesting accounting point information | ||
Path parameters | |||
{function} | GetAccountingPointData | ||
Query string parameters | |||
Name | Type | Obligation | Note |
{OrganisationUser} | String | Mandatory |
|
{MeteringPointEAN} | String(18) | Mandatory |
|
{CustomerIdentification} | String(50) | Mandatory |
|
{ViewDate} | DateTime | Mandatory | For terminated contracts use ContractEndDate. For confirmed contracts use CurrentDateTime |
Validation rules | |||
The requesting party must have a valid agreement (sales/grid agreement or authorisation agreement) with the customer on the view date. | |||
Response | |||
Accounting point information | |||
Request example | |||
https://{hostname}/rest/FGR/GetAccountingPointData?organisationUser={OrganisationUser}&meteringPointEAN={MeteringPointEAN}&customerIdentification={CustomerIdentification}&ViewDate={ViewDate} | |||
Returned accounting point information
DH-1000 – Get accounting point data return | |
Name | Obligation |
AccountingPoints | 0..1 |
AccountingPointType | 1..1 |
AccountingPointSubtype | 1..1 |
ElectricPower | 0..1 |
EnergyCommunityIdentifier | 0..1 |
EnergyCommunityName | 0..1 |
FuseSize | 0..1 |
IsHeatingDependentOnElectricity | 0..1 |
IsReactiveEnergyTimeSeriesAvailable | 0..1 |
IsRemotelyConnectable | 1..1 |
IsRemotelyReadable | 0..1 |
Latitude | 0..1 |
Longitude | 0..1 |
MeteringGridAreaCode | 1..1 |
MeteringMethod | 0..1 |
MeteringPointEAN | 1..1 |
MeteringPointStatus | 1..1 |
MeteringTimeDivision | 1..1 |
MeteringTimeStep | 1..1 |
MeterNumber | 0..1 |
UserGroup | 0..1 |
EstimatedYearlyUsages | 0..1 |
EstimatedYearlyUsage1 | 0..1 |
EstimatedYearlyUsage2 | 0..1 |
MeteringPointAddresses | 1..8 |
AddressType | 1..1 |
Apartment | 0..1 |
BuildingNumber | 0..1 |
CountryCode | 1..1 |
Language | 1..1 |
PostalCode | 1..1 |
PostOffice | 1..1 |
StairwellIdentification | 0..1 |
StreetName | 0..1 |
MeteringPointDevices (ControlledLoad) | 0..n |
ControlledLoadName | 0..1 |
ControlLimits | 0..1 |
Description | 0..1 |
DeviceType | 1..1 |
MaximumPower | 0..1 |
MaximumPowerUnit | 0..1 |
Timings | 0..1 |
MeteringPointDevices (ProductionDevice) | 0..n |
DeviceType | 1..1 |
MaximumPower | 0..1 |
MaximumPowerUnit | 0..1 |
ProductionDeviceName | 1..1 |
ProductionType | 1..1 |
MeteringPointDevices (StorageDevice) | 0..n |
Capacity | 0..1 |
CapacityUnit | 0..1 |
DeviceType | 1..1 |
MaximumPower | 0..1 |
MaximumPowerUnit | 0..1 |
StorageDeviceName | 1..1 |
StorageDeviceType | 1..1 |