DH-1001 Sopimustietojen noutaminen
POST-menetelmä
Resurssin kuvaus | ||
|---|---|---|
Määritelmä | Rajapinta sopimustietojen noutamista varten | |
Polun parametrit | ||
{funktio} | GetContractDataPost | |
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 sopimus (myynti- tai verkkosopimus) 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 | ||
Sopimustiedot, jotka ovat voimassa pyynnön esittämisen aikaan. | ||
Esimerkkipyyntö | ||
https://{palvelin}/rest/FGR/GetContractDataPostSanoman sisältö: {
"GetContractDataRequest": {
"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 sopimustietojen noutamista varten | |
Polun parametrit | ||
{funktio} | GetContractData | |
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 sopimus (myynti- tai verkkosopimus) 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 | ||
Sopimustiedot, jotka ovat voimassa pyynnön esittämisen aikaan. | ||
Esimerkkipyyntö | ||
https://{palvelin}/rest/FGR/GetContractData?organisationUser={OrganisaationKäyttäjä}&meteringPointEAN={KäyttöpaikanEAN}&customerIdentification={AsiakkaanTunnus} | ||
Palautetut myyntisopimuksen tiedot
DH-1001 – Get contract data return for sales agreement | |
|---|---|
Nimi | Pakollisuus |
Agreements | 0..n |
AgreementEndDate | 0..1 |
AgreementIdentification | 1..1 |
AgreementStartDate | 1..1 |
AgreementStatus | 1..1 |
AgreementType | 1..1 |
ContactMethod | 1..1 |
CustomerNote | 0..1 |
FixedTermEndDate | 0..1 |
FixedTermStartDate | 0..1 |
InvoicingChannel | 1..1 |
InvoicingMethod | 1..1 |
IsDeliveryAgreement | 1..1 |
IsFixedTermAgreement | 1..1 |
IsInterruptionCritical | 1..1 |
IsSpecialTerminationAgreement | 1..1 |
MarketRole | 1..1 |
MeteringPointEAN | 1..1 |
OrganisationIdentifier | 1..1 |
ReasonForAgreementEnd | 0..1 |
ReasonForAgreementStart | 1..1 |
SpecialTerminationPeriod | 0..1 |
TerminationPeriodStartDate | 0..1 |
TerminationPeriodEndDate | 0..1 |
AgreementContacts | 0..n |
ContactPersonType | 1..1 |
EmailAddress | 0..1 |
FamilyName | 0..1 |
GivenName | 0..1 |
OtherName | 0..1 |
TelephoneNumber | 0..1 |
InvoiceAddresses (PostalInvoicingAddress) | 1..1 |
AddressNote | 0..1 |
Apartment | 0..1 |
BuildingNumber | 0..1 |
CountryCode | 1..1 |
InvoicingAddressType | 1..1 |
POBox | 0..1 |
PostalCode | 1..1 |
PostOffice | 1..1 |
StairwellIdentification | 0..1 |
StreetName | 0..1 |
InvoiceAddresses (ElectronicInvoicingAddress) | 0..1 |
BuyerReference | 0..1 |
ElectronicInvoicingAddress | 1..1 |
InvoicingAddressType | 1..1 |
OperatorIdentification | 1..1 |
InvoiceAddresses (OtherInvoicingAddress) | 0..1 |
EmailAddress | 0..1 |
InvoicingAddressType | 1..1 |
TelephoneNumber | 0..1 |
Products | 0..n |
ProductCode | 1..1 |
ProductName | 1..1 |
ProductNameLanguage | 1..1 |
Palautetut verkkosopimuksen tiedot
DH-1001 – Get contract data return for grid agreement | |
|---|---|
Nimi | Pakollisuus |
Agreements | 0..n |
AgreementEndDate | 0..1 |
AgreementIdentification | 1..1 |
AgreementStartDate | 1..1 |
AgreementStatus | 1..1 |
AgreementType | 1..1 |
ContactMethod | 1..1 |
CustomerNote | 0..1 |
InvoicingChannel | 1..1 |
InvoicingMethod | 1..1 |
IsDeliveryAgreement | 1..1 |
IsInterruptionCritical | 1..1 |
MarketRole | 1..1 |
MeteringPointEAN | 1..1 |
OrganisationIdentifier | 1..1 |
ReasonForAgreementEnd | 0..1 |
ReasonForAgreementStart | 1..1 |
TaxCategory | 1..1 |
AgreementContacts | 0..n |
ContactPersonType | 1..1 |
EmailAddress | 0..1 |
FamilyName | 0..1 |
GivenName | 0..1 |
OtherName | 0..1 |
TelephoneNumber | 0..1 |
InvoiceAddresses (PostalInvoicingAddress) | 1..1 |
AddressNote | 0..1 |
Apartment | 0..1 |
BuildingNumber | 0..1 |
CountryCode | 1..1 |
InvoicingAddressType | 1..1 |
POBox | 0..1 |
PostalCode | 1..1 |
PostOffice | 1..1 |
StairwellIdentification | 0..1 |
StreetName | 0..1 |
InvoiceAddresses (ElectronicInvoicingAddress) | 0..1 |
BuyerReference | 0..1 |
ElectronicInvoicingAddress | 1..1 |
InvoicingAddressType | 1..1 |
OperatorIdentification | 1..1 |
InvoiceAddresses (OtherInvoicingAddress) | 0..1 |
EmailAddress | 0..1 |
InvoicingAddressType | 1..1 |
TelephoneNumber | 0..1 |
Products | 1..n |
ProductCode | 1..1 |
ProductName | 1..1 |
ProductNameLanguage | 1..1 |