DH-1005 Customer information retrieval
POST method
Resource description | ||
|---|---|---|
Definition | Interface for requesting customer information | |
Path parameters | ||
{function} | GetCustomerDataPost | |
Query string parameters | ||
Name | Type | Obligation |
{organisationUser} | String | Mandatory |
{customerIdentification} | String(50) | Mandatory |
Validation rules | ||
The requesting party must have a valid agreement or authorization with the customer at the time of request. Agreements starting in the future and agreements that have ended up to 6 weeks before the time of request are also returned. | ||
Response | ||
Customer information plus a list of the customer’s agreements, metering point identification and address valid at the time of request. | ||
Request example | ||
https://{hostname}/rest/FGR/GetCustomerDataPostContent of the posted message: {
"GetCustomerDataRequest": {
"organisationUser": "{OrganisationUser}",
"Filters": {
"customerIdentification": "{CustomerIdentification}",
}
}
} | ||
GET method
The GET method will be discontinued when version 2.6 is deployed.
Resource description | ||
|---|---|---|
Definition | Interface for requesting customer information | |
Path parameters | ||
{function} | GetCustomerData | |
Query string parameters | ||
Name | Type | Obligation |
{organisationUser} | String | Mandatory |
{customerIdentification} | String(50) | Mandatory |
Validation rules | ||
The requesting party must have a valid agreement or authorization with the customer at the time of request. Agreements starting in the future and agreements that have ended up to 6 weeks before the time of request are also returned. | ||
Response | ||
Customer data, a list of the customer’s agreements, metering point identification and address valid at the time of request. | ||
Request example | ||
https://{hostname}/rest/FGR/GetCustomerData?organisationUser={organisationUser}&customerIdentification={customerIdentification} | ||
Returned customer information
DH-1005 – Get customer data return | ||
|---|---|---|
Name | Obligation | Note |
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 | Metering point for the contract |
MeteringPointEAN | 1..1 |
|
MeteringPointStatus | 1..1 |
|
MeteringPointAddress | 1..1 | Main address for the metering point |
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 |
|