Change Of Allocation Method

create

Method	URL
POST	api/esh/change_of_allocation_method/create

Smart meter allocation makes it possible to include small-scale electricity connections with a smart meter in the allocation based on actual measured values compared to the current allocation method based on profiles for small-scale connections.

Pre-requisite steps

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

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.

Global Task steps

1. The ValueA adapter sends out the request to EDSN via an XML request: ChangeOfAllocationMethodRequest.

2. EDSN validates the request (see EDSN validations). If there are inaccuracies, the message is rejected otherwise an update is send via an XML response: ChangeOfAllocationMethodResponse.

3. When a rejection is received the status of the GlobalTask is set to rejected.

4. When an update is received the status of the GlobalTask is set to rejected.

Create input parameters

change_of_allocation_method global_task input parameters
type	object
properties
ean_id	type	string
	pattern	^[0-9]{18}$
valid_from_date	Date format as defined in RFC 3339, section 5.6.
	type	string
	format	date
grid_operator_company_id	type	string
	pattern	^[0-9]{13}$
balance_supplier_company_id	type	string
	pattern	^[0-9]{13}$
allocation_method	Profiled, Smart Meter Allocation
	enum	PRF, SMA
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 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
Is the connection an electricity small-scale connection?	Connection is not a electricity small-scale consumption connection	257
Is the initiating supplier the active supplier on the connection?	EAN-code supplier unknown	204
Is the connection administrative status smart meter On?	Administrative Status Smart Meter is not On	258
The meter on the connection is technically remotely readable?	Meter is technically not remotely readable	259
Does the notification represent a change?	The notification does not represent a change	260
The notification is submitted today	Incorrect submission period	210
It is checked that there is no intersecting process causing a rejection	Intersecting process	227

Create return parameters

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

Get data input parameters

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

Get data return parameters

change_of_allocation_method get_data return parameters
type	object
properties
id	GlobalTask.id
	type	string
	format	uuid
type	GlobalTask.type
	type	string
update	type	object
	properties
	grid_operator_company_id	type	string
		pattern	^[0-9]{13}$
	balance_supplier_company_id	type	string
		pattern	^[0-9]{13}$
rejection	type	object
	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
error	type	object
	properties
	messsageid	ValueA Broker message.id
		type	string
		format	uuid
	validations	type	array
		items	get_data_validation

reason

type	object
properties
code	type	string
text	type	string

get_data_validation

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