Notice Eos

create

Method	URL
POST	api/esh/notice_eos/create

The current End of Supply process, as it has been applicable since the introduction of the NMM on 1 August 2013, is based on the fact that smart meters are equipped with remotely switchable functionality. Prior to submitting an End of Supply request, a switching order would first have to be issued with which the energy supply of the relevant meter would be stopped. However, as a result of the draft Amendment Decree, the obligation for a switch in the smart meter has been dropped. As a result, it is no longer possible for the supplier to issue a switching order before submitting an End of Supply. As a result of this situation, the grid operator is no longer or barely able to meet the legal deadlines for this process. The identifiable cause is:

• The lack of switching functionality;

• The large numbers of end deliveries that are submitted.

IC159 states that it is important to inform the grid operator earlier about the End of Supply requests to be submitted and that there should therefore be a Pre-Announcement End of Supply.

Pre-requisite steps

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

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_eos global_task input parameters
type	object
properties
ean_id	type	string
	pattern	^[0-9]{18}$
grid_operator_company_id	type	string
	pattern	^[0-9]{13}$
balance_supplier_company_id	type	string
	pattern	^[0-9]{13}$
mutation_date	Date format as defined in RFC 3339, section 5.6.
	type	string
	format	date
grid_contract_party	properties
	initials	type	string / null
		maxLength	5
		minLength	1
	surname	type	string
		maxLength	24
		minLength	1
	surname_prefix	type	string / null
		maxLength	4
		minLength	1
	additionalProperties	False
contact	properties
	street_name	type	string / null
		maxLength	24
		minLength	1
	building_nr	type	integer
		maximum	99999
		minimum	1
	ex_building_nr	type	string / null
		maxLength	6
		minLength	1
	zip_code	type	string
		maxLength	6
		minLength	1
	city_name	type	string / null
		maxLength	24
		minLength	1
	country	type	string / null
		maxLength	2
		minLength	2
	phone	type	string / null
		maxLength	20
		minLength	1
	email	type	string / null
		maxLength	100
		minLength	1
	additionalProperties	False
use_local_data_for_validation	If true then the latest available MeteringPoint data will be used to perform additional validations
	type	boolean
	default	False

EDSN validations

validation	error message	error code
The request to consult, a connection is complete and syntactically correct	Message incomplete or syntactically incorrect	200
The grid operator company EAN code is known in the grid operator register	EAN-code grid operator unknown	230
The supplier’s company EAN code is known in the supplier register	EAN-code requesting party unknown	202

Output parameters

notice_eos 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

Note

There are no functional return parameters for this process so a get_data method is not available.

getStatus

Method	URL
GET	api/esh/notice_eos/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

sendMessages

Method	URL
POST	api/esh/notice_eos/send_messages

This Task wil send all available NoticeEOS(Notifications) to EDSN.

Send input parameters

notice_eos send_messages input parameters
type	object
properties

Send return parameters

notice_eos send_messages return parameters
type	object
properties
message_type	type	string
message_ids	type	array
	items	EDSN message.id
		type	string
		format	uuid
error	type	object
	properties
	messsageid	ValueA Broker message.id
		type	string
		format	uuid
	validations	type	array
		items	send_validation

send_validation

type	object
properties
message	type	string
ref	optional reference to parameter
	type	string / null
user_message	type	string / null