Name Change

create

Method	URL
POST	api/esh/name_change/create

The Name Change process is used by the supplier to correct spelling errors in the customer name in the connection register. The supplier will initiate the Name Change process on its own initiative as a result of contact with the customer.

Pre-requisite steps

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

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.

Global Task steps

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

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

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

4. When a confirmation is received the status of the GlobalTask is set to ready.

Input parameters

name_change 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}$
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
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 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
Is the initiating supplier the active supplier on the connection?	EAN-code supplier unknown	204
The connection is a gas connection, an electricity allocation point or a primary electricity allocation point	EAN-code connection unknown	201
The connection is a small consumption connection	It’s a GVB / ART connection / allocation point	264

Output parameters

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

Get data input parameters

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

Get data return parameters

name_change get_data return parameters
type	object
properties
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

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/name_change/send_messages

This Task wil send all available NameChange messages to EDSN.

Send Input parameters

name_change send_messages input parameters
type	object
properties

Send return parameters

name_change 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