End Of Supply

create

Method	URL
POST	api/esh/end_of_supply/create

The End of Supply process is used by the current supplier to terminate its supply on a connection, with the customer’s disposition over the connection continuing. The conditions of the “Regulation on the termination policy for small consumers of electricity and gas” apply to this process.

Pre-requisite steps

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

2. If the validation of the create 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.

Create input parameters

end_of_supply 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
use_local_data_for_validation	If true then the latest available MeteringPoint data will be used to perform additional validations
	type	boolean
	default	False

Adapter validations

These validation will only be performed if use_local_data_for_validation is set to true or data needed for the validation is supplied in the request.

validation	error message	error code
The connection belongs to the domain of the relevant network operator	EAN-code connection unknown	201
The connection to which the request relates may not have been physically demolished	EAN-code connection unknown	201
The notification for a small-scale connection is submitted in the period 20 working days up to and including 1 working day before the change date	Incorrect submission period	210
The notification for a large-scale connection is submitted in the period 20 working days up to and including 12 working days before the change date	Incorrect submission period	210

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 connection is known within the C-AR	EAN-code connection unknown	201
The connection belongs to the domain of the relevant network operator	EAN-code connection unknown	201
The connection to which the request relates may not have been physically demolished	EAN-code connection unknown	201
The connection point is of the normal type	EAN-code connection unknown	201
The notification for a small-scale connection is submitted in the period 20 working days up to and including 1 working day before the change date	Incorrect submission period	210
The notification for a large-scale connection is submitted in the period 20 working days up to and including 12 working days before the change date	Incorrect submission period	210
Is the initiating supplier the active supplier on the connection?	EAN-code supplier unknown	204
It is checked that there is no intersecting process causing a rejection	Intersecting process	227
The connection is not blocked for automatic transactions	Blocked for automatic mutations	208

Create return parameters

end_of_supply 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/end_of_supply/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/end_of_supply/get_data

Get data input parameters

end_of_supply get_data input parameters
type	object
properties
id	GlobalTask.id
	type	string
	format	uuid

Get data return parameters

end_of_supply get_data return parameters
type	object
properties
loss	properties
	mutation_date	type	string
		format	date
	grid_operator_company_id	type	string
		pattern	^[0-9]{13}$
	old_balance_supplier_company_id	type	string
		pattern	^[0-9]{13}$
	product_type	enum	ELK, GAS
rejection	properties
	grid_operator_company_id	type	string
		pattern	^[0-9]{13}$
	balance_supplier_company_id	type	string
		pattern	^[0-9]{13}$
	reasons	type	array
		items	reason
cancellation	properties
	process_code	Code of process which caused the cancellation
		type	string
	text	type	string
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

sendMessages

Method	URL
POST	api/esh/end_of_supply/send_messages

This Task wil send all available EndOfSupply messages to EDSN.

Send input parameters

end_of_supply send_messages input parameters
type	object
properties

Send return parameters

end_of_supply 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	validation

validation

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