DH-1000 Käyttöpaikan tietojen noutaminen
POST-menetelmä
Resurssin kuvaus | |||
|---|---|---|---|
Määritelmä | Rajapinta käyttöpaikan tietojen pyytämistä varten | ||
Polun parametrit | |||
{funktio} | GetAccountingPointDataPost | ||
Sanoman parametrit | |||
Nimi | Tyyppi | Velvoite | Huomautus |
{OrganisaationKäyttäjä} | Merkkijono | Pakollinen |
|
{KäyttöpaikanEAN} | Merkkijono(18) | Pakollinen |
|
{AsiakkaanTunnus} | Merkkijono(50) | Pakollinen |
|
{NäkymänPäivämäärä} | Päivämäärä ja aika | Pakollinen | Päättyneissä sopimuksissa käytetään ContractEndDate-parametria. Vahvistetuissa sopimuksissa käytetään CurrentDateTime-parametria. |
Kelpoisuussäännöt | |||
Pyynnön esittäneellä osapuolella on oltava voimassa oleva sopimus (myynti-/verkkosopimus tai valtuutussopimus) asiakkaan kanssa katselupäivänä. | |||
Vastaus | |||
Käyttöpaikan tiedot | |||
Esimerkkipyyntö | |||
https://{palvelin}/rest/FGR/GetAccountingPointDataPostSanoman sisältö: {
"GetAccountingPointDataRequest": {
"organisationUser": "{OrganisaationKäyttäjä}",
"Filters": {
"meteringPointEAN": "{KäyttöpaikanEAN}",
"customerIdentification": "{AsiakkaanTunnus}",
"ViewDate": "{NäkymänPäivämäärä}"
}
}
} | |||
GET-menetelmä
GET-menetelmä poistuu käytöstä version 2.6 käyttöönoton yhteydessä.
Resurssin kuvaus | |||
|---|---|---|---|
Määritelmä | Rajapinta käyttöpaikan tietojen pyytämistä varten | ||
Polun parametrit | |||
{funktio} | GetAccountingPointData | ||
Kyselymerkkijonon parametrit | |||
Nimi | Tyyppi | Velvoite | Huomautus |
{OrganisaationKäyttäjä} | Merkkijono | Pakollinen |
|
{KäyttöpaikanEAN} | Merkkijono(18) | Pakollinen |
|
{AsiakkaanTunnus} | Merkkijono(50) | Pakollinen |
|
{NäkymänPäivämäärä} | Päivämäärä ja aika | Pakollinen | Päättyneissä sopimuksissa käytetään ContractEndDate-parametria. Vahvistetuissa sopimuksissa käytetään CurrentDateTime-parametria. |
Kelpoisuussäännöt | |||
Pyynnön esittäneellä osapuolella on oltava voimassa oleva sopimus (myynti-/verkkosopimus tai valtuutussopimus) asiakkaan kanssa katselupäivänä. | |||
Vastaus | |||
Käyttöpaikan tiedot | |||
Esimerkkipyyntö | |||
https://{palvelin}/rest/FGR/GetAccountingPointData?organisationUser={OrganisaationKäyttäjä}&meteringPointEAN={KäyttöpaikanEAN}&customerIdentification={AsiakkaanTunnus}&ViewDate={NäkymänPäivämäärä} | |||
Palautetut käyttöpaikan tiedot
DH-1000 – Get accounting point data return | |
|---|---|
Nimi | Pakollisuus |
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 |