WS are secured using the following mechanisms:
▪ HTTPS protocol
▪ Username and password authentication
▪ Client certificate authentication
| Requirement | Description |
| SSL authentication by client certificate | SSL handshake is performed when client sends a request to WS. An electronic certificate and login and password authentication is required, therefore the client WS software must support SSL authentication by client certificate. |
| SOAP version |
Messages must be in line with SOAP version 1.1 for the operations “put”, “list” and “get”. Messages must be in line with SOAP version 1.2 for “listOpenauction” and “getOfferedCapacityForauction”
|
Submission of document
Submission of a document can be done via SOAP message as binary base64 encoded strings (this applies for all supported document types). Please be aware that you will be technically limited to one request per second per user.
WS process all messages in the pipeline and performs document type recognition and validations among other operations.
As a consequence, the operation “put” is not aware of the format or type of submitted message.
Operation “put”
The operation “put” allows authenticated, authorized users to submit documents.
The request contains submitted file name together with its binary content (base64 encoded string).
Result of the operation is returned to client as ENTSO acknowledgment v5r0 message within SOAP message (as character data).
Downloading documents
The process of downloading documents is summarized in the following chart:
The steps must be executed by the WS client in the following order:
- list – remote system will list messages for specified criteria,
- check missing messages – remote system will check which messages weren’t downloaded yet by message ID,
- get – remote system will request download of missing messages payload by using message ID.
Operation “list”
The operation “list” provides WS client with the ability to get a list of all messages, which fulfils the filtering criteria.
Filtering criteria parameters are a combination of code value parameters and time interval parameters.
- dataflow code (required)
- document type (optional)
- sender party EIC code (optional)
- receiver party EIC code (optional)
- domain code (EIC, optional)
- applicable time interval range (required*)
- applicableTimeFromUTC/applicableTimeToUTC = Market Period (can be any range)
- timestamp range (required*)
- timeFromUTC/timeToUTC = Publication Time (must be within 24 hours range)
Data flow code and *time range (applicable time interval OR timestamp) are the only mandatory criteria.
Currently supported data flows codes and document types are listed at the table below.
Please note, that dataflow and document type codes are maintained by eCAT and they can be subject to change.
The operation “list” only allows access to documents listed here below:
|
OUTPUT |
Definition |
Document type code |
|
A_TR |
approved transfer |
ecan-rights-document-v4_0 |
|
AR |
allocation results |
ecan-allocation-results-document-v4_0 |
|
D_CUA |
daily capacity usage authorization |
ecan-rights-document-v4_0 |
|
I_CUA |
intraday capacity usage authorization |
ecan-rights-document-v4_0 |
|
LT_CUA |
long term capacity usage authorization |
ecan-rights-document-v4_0 |
|
MAX_AAC |
maximum already allocated capacity |
ecan-rights-document-v4_0 |
|
MIN_AAC |
minimum already allocated capacity |
ecan-rights-document-v4_0 |
|
INPUT |
Definition |
Document type code |
|
BID |
auction bid |
ecan-bid-v4_0 |
|
RETURN |
resale request |
ecan-rights-document-v4_0 |
|
TR |
transfer request |
ecan-rights-document-v4_0 |
The operation “list” does not return payload messages directly, instead only message IDs are returned (please note that it is a technical message ID generated by the system).
The result set is limited to 100 messages.
Operation “get”
The operation “get” is used by WS client to retrieve payload of any document using document ID.
Document ID can be obtained from the operation “list” which supports criteria search.
Document payload is returned as binary data (encoded as base64 string).
When document ID is not found, SOAP fault message is returned.
Open auctions
The operation “listOpenauctions” allows users to request a list of auctions that are currently opened.
This WS does not require any parameter. If no auction is running, the WS will explicitly return that no auction is open.
Offered capacity
The operation “getOfferedCapacityForauction” allows users to request the offered capacity of a particular auction.
The WS will use the target auction ID as an entry parameter and will return:
-
If the auction ID doesn’t correspond to an auction within the system, an error message stating the auction is unknown
-
If the bid submission gate is not open, an error message stating the auction is not open
-
If the bid submission gate is open, the offered capacity of the target auction (in auction specification format).
-
If the bid submission gate is closed, the offered capacity of the target auction (in auction specification format) and a message stating the auction is closed.
