DH-1003 Valtuutustietojen noutaminen
POST-menetelmä
Resurssin kuvaus | ||
|---|---|---|
Määritelmä | Rajapinta valtuutustietojen pyytämistä varten | |
Polun parametrit | ||
{funktio} | GetAuthorisationDataPost | |
Sanoman parametrit | ||
Nimi | Tyyppi | Velvoite |
{OrganisaationKäyttäjä} | Merkkijono | Pakollinen |
{KäyttöpaikanEAN} | Merkkijono(18) | Pakollinen |
{AsiakkaanTunnus} | Merkkijono(50) | Pakollinen |
Kelpoisuussäännöt | ||
Pyynnön esittäneellä osapuolella on oltava voimassa oleva valtuutus asiakkaan kanssa pyynnön esittämisen aikaan. | ||
Vastaus | ||
Valtuutustiedot, jotka ovat voimassa pyynnön esittämisen aikaan. | ||
Esimerkkipyyntö | ||
https://{palvelin}/rest/FGR/GetAuthorisationDataPostSanoman sisältö: {
"GetAuthorisationDataRequest": {
"organisationUser": "{OrganisaationKäyttäjä}",
"Filters": {
"meteringPointEAN": "{KäyttöpaikanEAN}",
"customerIdentification": "{AsiakkaanTunnus}"
}
}
} | ||
GET-menetelmä
GET-menetelmä poistuu käytöstä version 2.6 käyttöönoton yhteydessä.
Resurssin kuvaus | ||
|---|---|---|
Määritelmä | Rajapinta valtuutustietojen pyytämistä varten | |
Polun parametrit | ||
{funktio} | GetAuthorisationData | |
Kyselymerkkijonon parametrit | ||
Nimi | Tyyppi | Velvoite |
{OrganisaationKäyttäjä} | Merkkijono | Pakollinen |
{KäyttöpaikanEAN} | Merkkijono(18) | Pakollinen |
{AsiakkaanTunnus} | Merkkijono(50) | Pakollinen |
Kelpoisuussäännöt | ||
Pyynnön esittäneellä osapuolella on oltava voimassa oleva valtuutus asiakkaan kanssa pyynnön esittämisen aikaan. | ||
Vastaus | ||
Valtuutustiedot, jotka ovat voimassa pyynnön esittämisen aikaan. | ||
Esimerkkipyyntö | ||
https://{palvelin}/rest/FGR/GetAuthorisationData?organisationUser={OrganisaationKäyttäjä}&meteringPointEAN={KäyttöpaikanEAN}&customerIdentification={AsiakkaanTunnus} | ||
Palautetut valtuutustiedot
DH-1003 – Get authorisation data return | |
|---|---|
Nimi | Pakollisuus |
Agreements | 0..n |
AgreementEndDate | 1..1 |
AgreementStartDate | 1..1 |
AgreementStatus | 1..1 |
AgreementType | 1..1 |
AuthorisationDescription | 0..1 |
AuthorisationReason | 1..1 |
MarketRole | 1..1 |
MeteringPointEAN | 1..1 |
OrganisationIdentifier | 1..1 |