DH-1005 Asiakastietojen noutaminen
POST-menetelmä
Resurssin kuvaus | ||
|---|---|---|
Määritelmä | Rajapinta asiakastietojen pyytämistä varten | |
Polun parametrit | ||
{funktio} | GetCustomerDataPost | |
Sanoman parametrit | ||
Nimi | Tyyppi | Velvoite |
{OrganisaationKäyttäjä} | Merkkijono | Pakollinen |
{AsiakkaanTunnus} | Merkkijono(50) | Pakollinen |
Kelpoisuussäännöt | ||
Pyynnön esittäneellä osapuolella on oltava voimassa oleva sopimus tai valtuutus asiakkaan kanssa pyynnön esittämisen aikaan. Myös tulevaisuudessa alkavat sopimukset ja sopimukset, jotka ovat päättyneet 6 viikon sisällä ennen pyynnön ajankohtaa, palautetaan. | ||
Vastaus | ||
Asiakastiedot, luettelo asiakkaan sopimuksista sekä mittauspisteen tunnus ja osoite, jotka ovat voimassa pyynnön esittämisen aikaan. | ||
Esimerkkipyyntö | ||
https://{palvelin}/rest/FGR/GetCustomerDataPostSanoman sisältö: {
"GetCustomerDataRequest": {
"organisationUser": "{OrganisaationKäyttäjä}",
"Filters": {
"customerIdentification": "{AsiakkaanTunnus}",
}
}
} | ||
GET-menetelmä
GET-menetelmä poistuu käytöstä version 2.6 käyttöönoton yhteydessä.
Resurssin kuvaus | ||
|---|---|---|
Määritelmä | Rajapinta asiakastietojen pyytämistä varten | |
Polun parametrit | ||
{funktio} | GetCustomerData | |
Kyselymerkkijonon parametrit | ||
Nimi | Tyyppi | Velvoite |
{OrganisaationKäyttäjä} | Merkkijono | Pakollinen |
{AsiakkaanTunnus} | Merkkijono(50) | Pakollinen |
Kelpoisuussäännöt | ||
Pyynnön esittäneellä osapuolella on oltava voimassa oleva sopimus tai valtuutus asiakkaan kanssa pyynnön esittämisen aikaan. Myös tulevaisuudessa alkavat sopimukset ja sopimukset, jotka ovat päättyneet 6 viikon sisällä ennen pyynnön ajankohtaa, palautetaan. | ||
Vastaus | ||
Asiakastiedot, luettelo asiakkaan sopimuksista sekä mittauspisteen tunnus ja osoite, jotka ovat voimassa pyynnön esittämisen aikaan. | ||
Esimerkkipyyntö | ||
https://{palvelin}/rest/FGR/GetCustomerData?organisationUser={OrganisaationKäyttäjä}&customerIdentification={AsiakkaanTunnus} | ||
Palautetut asiakastiedot
DH-1005 – Get customer data return | ||
|---|---|---|
Nimi | Pakollisuus | Huomautus |
Customers | 0..1 |
|
AdditionalIdentification | 0..1 |
|
CompanyName | 0..1 |
|
CustomerIdentification | 1..1 |
|
CustomerIdentificationType | 1..1 |
|
CustomerSubtype | 1..1 |
|
CustomerType | 1..1 |
|
DateOfBirth | 0..1 |
|
EmailAddress | 0..1 |
|
FamilyName | 0..1 |
|
GivenName | 0..1 |
|
IsInformationRestricted | 1..1 |
|
Language | 1..1 |
|
MiddleNames | 0..1 |
|
TelephoneNumber | 0..1 |
|
CustomerPostalAddress | 1..1 |
|
AddressNote | 0..1 |
|
Apartment | 0..1 |
|
BuildingNumber | 0..1 |
|
CountryCode | 1..1 |
|
POBox | 0..1 |
|
PostalCode | 1..1 |
|
PostOffice | 1..1 |
|
StairwellIdentification | 0..1 |
|
StreetName | 0..1 |
|
Agreements | 1..n |
|
AgreementEndDate | 0..1 |
|
AgreementStartDate | 1..1 |
|
AgreementStatus | 1..1 |
|
AgreementType | 1..1 |
|
MeteringPoint | 1..1 | Sopimukseen liittyvä käyttöpaikka |
MeteringPointEAN | 1..1 |
|
MeteringPointStatus | 1..1 |
|
MeteringPointAddress | 1..1 | Käyttöpaikan pääosoite |
AddressNote | 0..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 |
|