DH-1001 Contractual information retrieval
POST method
Resource description | ||
|---|---|---|
Definition | Interface for requesting contractual information | |
Path parameters | ||
{function} | GetContractDataPost | |
Query string parameters | ||
Name | Type | Obligation |
{organisationUser} | String | Mandatory |
{meteringPointEAN} | String(18) | Mandatory |
{customerIdentification} | String(50) | Mandatory |
Validation rules | ||
The requesting party must have a valid agreement (sales or grid agreement) with the customer at the time of request. Also, agreements starting in the future and agreements that have ended up to 6 weeks before the time of request are returned. | ||
Response | ||
Contractual information valid at the time of request | ||
Request example | ||
https://{hostname}/rest/FGR/GetContractDataPostContent of the posted message: {
"GetContractDataRequest": {
"organisationUser": "{OrganisationUser}",
"Filters": {
"meteringPointEAN": "{MeteringPointEAN}",
"customerIdentification": "{CustomerIdentification}",
}
}
} | ||
GET method
The GET method will be discontinued when version 2.6 is deployed.
Resource description | ||
|---|---|---|
Definition | Interface for requesting contractual information | |
Path parameters | ||
{function} | GetContractData | |
Query string parameters | ||
Name | Type | Obligation |
{organisationUser} | String | Mandatory |
{meteringPointEAN} | String(18) | Mandatory |
{customerIdentification} | String(50) | Mandatory |
Validation rules | ||
The requesting party must have a valid agreement (sales or grid agreement) with the customer at the time of request. Also, agreements starting in the future and agreements that have ended up to 6 weeks before the time of request are returned. | ||
Response | ||
Contractual information valid at the time of request | ||
Request example | ||
https://{hostname}/rest/FGR/GetContractData?organisationUser={organisationUser}&meteringPointEAN={meteringPointEAN}&customerIdentification={customerIdentification} | ||
Returned contractual information for sales agreements
DH-1001 – Get contract data return for sales agreement | |
|---|---|
Name | Obligation |
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 |
Returned contractual information for grid agreements
DH-1001 – Get contract data return for grid agreement | |
|---|---|
Name | Obligation |
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 |