DH-1003 Authorization information retrieval
POST method
Resource description | ||
|---|---|---|
Definition | Interface for requesting authorization information | |
Path parameters | ||
{function} | GetAuthorisationDataPost | |
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 authorization with the customer at the time of request. | ||
Response | ||
Authorization information valid at the time of request. | ||
Esimerkkipyyntö | ||
https://{hostname}/rest/FGR/GetAuthorisationDataPostContent of the posted message: {
"GetAuthorisationDataRequest": {
"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 authorization information | |
Path parameters | ||
{function} | GetAuthorisationData | |
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 authorization with the customer at the time of request. | ||
Response | ||
Authorization information valid at the time of request. | ||
Esimerkkipyyntö | ||
https://{hostname}/rest/FGR/GetAuthorisationData?organisationUser={organisationUser}&meteringPointEAN={meteringPointEAN}&customerIdentification={customerIdentification} | ||
Returned authorization information
DH-1003 – Get authorisation data return | |
|---|---|
Name | Obligation |
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 |