Notice Contract
create
Method |
URL |
|---|---|
|
api/esh/notice_contract/create |
The CER offers suppliers the option to register a temporary contract to be confirmed in the CER. The contracts that have been registered in this way will remain actively registered for 1 month to enable requests from C-AR and CER. In this contract phase, the supplier has a contract to be confirmed with the customer, but is not yet registered as a supplier in the C-AR.
Pre-requisite steps
The initiator sends a request to create a Global Task
notice_contractIf the validation of the input parameters results in an error the ‘Global Task’ is not created and the errors are returned.
A Global Task is created and the GlobalTask.ID is returned.
Input parameters
notice_contract global_task input parameters |
||
type |
object |
|
properties |
||
|
type |
string |
pattern |
^[0-9]{18}$ |
|
|
type |
string |
pattern |
^[0-9]{13}$ |
|
EDSN validations
validation |
error message |
error code |
|---|---|---|
The request to consult, a connection is complete and syntactically correct |
Message incomplete or syntactically incorrect |
200 |
Supplier is authenticated |
The requesting party is not authenticated |
000 |
Supplier is authorized |
EAN-code requesting party unknown |
202 |
The connection is known within the CER |
EAN-code connection unknown |
201 |
The requesting market party is known to the grid operator as a legal entity |
EAN-code requesting party unknown |
202 |
Output parameters
notice_contract global_task return parameters |
|||
properties |
|||
|
GlobalTask.id |
||
type |
string |
||
format |
uuid |
||
|
type |
object |
|
properties |
|||
|
ValueA Broker message.id |
||
type |
string |
||
format |
uuid |
||
|
type |
array |
|
items |
|||
global_task_validation
type |
object |
|
properties |
||
|
type |
string |
|
optional reference to parameter |
|
type |
string / null |
|
|
type |
string / null |
getStatus
Method |
URL |
|---|---|
|
api/esh/notice_contract/get_status |
Get status input parameters
global_task get_status input parameters |
||
type |
object |
|
properties |
||
|
GlobalTask.id |
|
type |
string |
|
format |
uuid |
|
Get status return parameters
global_task get_status return parameters |
|||
type |
object |
||
properties |
|||
|
type |
string |
|
|
type |
string |
|
format |
date |
||
|
type |
string / null |
|
|
type |
array |
|
items |
|||
|
type |
object |
|
properties |
|||
|
ValueA Broker message.id |
||
type |
string |
||
format |
uuid |
||
|
type |
array |
|
items |
|||
status_detail
type |
object |
|
properties |
||
|
type |
string |
|
type |
string / null |
get_status_validation
type |
object |
|
properties |
||
|
type |
string |
|
optional reference to parameter |
|
type |
string / null |
|
|
type |
string / null |
getData
Method |
URL |
|---|---|
|
api/esh/notice_contract/get_data |
Get data input parameters
notice_contract get_data input parameters |
||
type |
object |
|
properties |
||
|
GlobalTask.id |
|
type |
string |
|
format |
uuid |
|
Get data return parameters
notice_contract get_data return parameters |
|||
type |
object |
||
properties |
|||
|
type |
object |
|
|
type |
object |
|
properties |
|||
|
type |
string |
|
pattern |
^[0-9]{13}$ |
||
|
type |
array |
|
items |
|||
|
type |
object |
|
properties |
|||
|
ValueA Broker message.id |
||
type |
string |
||
format |
uuid |
||
|
type |
array |
|
items |
|||
reason
properties |
||
|
type |
string |
|
type |
string / null |
get_data_validation
type |
object |
|
properties |
||
|
type |
string |
|
optional reference to parameter |
|
type |
string / null |
|
|
type |
string / null |