Client Key

create

Method	URL
POST	api/esh/client_key/create

For the purpose of checking the legality of requests from central registers, the grid operators jointly manage a central administration for customer keys. The customer keys are supplied by the current supplier on a small consumption connection. The administration is intended for identification of the customer by checking customer keys which are provided by a supplier in a request for data of a connection from the central registers.

The supplier submits the customer keys in the following cases at the latest within one working day after a:

• Change If Supplier;

• Move In;

• Change customer key(s) for existing customer.

Pre-requisite steps

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

2. If the validation of the input parameters or or the adapter validations 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: CreateCKRequest.

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: CreateCKResponse.

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

client_key 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}$
birth_day_key	month and day of birth –MM-DD
	type	string / null
	pattern	^–[0-2][0-9]-[0-3][0-9]$
	default	null
iban_key	type	string / null
	pattern	^[0-9]{3}$
	default	null

Adapter validations

validation	error message	error code
At least one of the two customer keys has been provided	No customer key present	604

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 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 connection is a small consumption connection	It’s a GVB / ART connection / allocation point	264
At least one of the two customer keys has been provided	No customer key present	604
Is the initiating supplier the active supplier on the connection?	EAN-code supplier unknown	204

Output parameters

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

Get data input parameters

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

Get data return parameters

client_key get_data return parameters
type	object
properties
id	GlobalTask.id
	type	string
	format	uuid
type	GlobalTask.type
	type	string
confirmation	type	object
	additionalProperties	False
client_key_rejection	type	object
	properties
	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