Notice Contract

create

Method

URL

POST

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.

../_images/notice_contract.global_task.png

Pre-requisite steps

  1. The initiator sends a request to create a Global Task notice_contract

  2. If the validation of the input parameters results in an error the ‘Global Task’ is not created and the errors are returned.

  3. A Global Task is created and the GlobalTask.ID is returned.

Input parameters

notice_contract global_task input parameters

type

object

properties

  • ean_id

type

string

pattern

^[0-9]{18}$

  • balance_supplier_company_id

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

  • global_task_id

GlobalTask.id

type

string

format

uuid

  • error

type

object

properties

  • messsageid

ValueA Broker message.id

type

string

format

uuid

  • validations

type

array

items

global_task_validation

global_task_validation

type

object

properties

  • message

type

string

  • ref

optional reference to parameter

type

string / null

  • user_message

type

string / null

getStatus

Method

URL

GET

api/esh/notice_contract/get_status

Get status input parameters

global_task get_status input parameters

type

object

properties

  • id

GlobalTask.id

type

string

format

uuid

Get status return parameters

global_task get_status return parameters

type

object

properties

  • status

type

string

  • status_date

type

string

format

date

  • status_description

type

string / null

  • status_details

type

array

items

status_detail

  • error

type

object

properties

  • messsageid

ValueA Broker message.id

type

string

format

uuid

  • validations

type

array

items

get_status_validation

status_detail

type

object

properties

  • description

type

string

  • remark

type

string / null

get_status_validation

type

object

properties

  • message

type

string

  • ref

optional reference to parameter

type

string / null

  • user_message

type

string / null

getData

Method

URL

GET

api/esh/notice_contract/get_data

Get data input parameters

notice_contract get_data input parameters

type

object

properties

  • id

GlobalTask.id

type

string

format

uuid

Get data return parameters

notice_contract get_data return parameters

type

object

properties

  • confirmation

type

object

  • notice_contract_rejection

type

object

properties

  • balance_supplier_company_id

type

string

pattern

^[0-9]{13}$

  • reasons

type

array

items

reason

  • error

type

object

properties

  • messsageid

ValueA Broker message.id

type

string

format

uuid

  • validations

type

array

items

get_data_validation

reason

properties

  • code

type

string

  • text

type

string / null

get_data_validation

type

object

properties

  • message

type

string

  • ref

optional reference to parameter

type

string / null

  • user_message

type

string / null