Master Data Metering

create

Method	URL
POST	api/esh/master_data_metering/create

A supplier which is authorized by the connected party can request master data from the metering facility from the metering responsibly party.

Pre-requisite steps

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

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

EDSN rejection handling

1. EDSN validates the request (see EDSN validations). If there are inaccuracies, the message is rejected.

2. The ValueA adapter collects the rejection or confirmation from EDSN: MasterDataMeteringResponse.

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

Metering Responsible response handling

1. The Metering Responsible validates the request (see Metering Responsible validations). If there are inaccuracies, the message is rejected, otherwise the master data metering result is returned.

2. The ValueA adapter collects the rejections send by the Metering Responsible, if available, from EDSN: MasterDataMeteringRejection.

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

4. The ValueA adapter collects the results send by the Metering Responsible, if available, from EDSN: MasterDataMeteringResult.

5. The result is validated for invalid domain values. If there are inaccuracies, the result is rejected and the status of the GlobalTask is set to rejected.

6. Otherwise the status of the GlobalTask is set to ready.

Input parameters

master_data_metering global_task input parameters
type	object
properties
ean_id	type	string
	pattern	^[0-9]{18}$
metering_responsible_party_company_id	type	string
	pattern	^[0-9]{13}$
initiator	type	string
	pattern	^[0-9]{13}$
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 metering responsible company EAN code is known in the metering responsible register	EAN-code metering responsible unknown	205

Metering Responsible 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 belongs to the domain of the relevant metering responsible	EAN-code connection unknown	201
The initiator company EAN code is known in the market party register	EAN-code grid operator unknown	230

Output parameters

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

Get data input parameters

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

Get data return parameters

master_data_metering get_data return parameters
type	object
properties
master_data_metering_result	type	object
	properties
	metering_responsible_party_company_id	type	string
		pattern	^[0-9]{13}$
	consumer	type	string
		pattern	^[0-9]{13}$
	valid_from_date	type	string
		format	date
	product_type	enum	ELK, GAS
	metered_assets	type	array
		items	metered_asset
master_data_metering_rejection	type	object
	properties
	consumer	type	string
		pattern	^[0-9]{13}$
	metering_responsible_party_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

metered_asset

type	object
properties
metered_asset_id	type	string
meter_id	type	string
capacity	enum	G4, G6, G10, G16, G25, G40, G65, G100, G160, G250, G400, G650, G1000, G1600, G2500, OBK
registers	type	array
	items	register

register

type	object
properties
register_id	type	string
nr_of_digits	type	integer
	maximum	9
	minimum	1
tariff_type	enum	L, N
metering_direction	enum	LVR, TLV
conversion	enum	E01, E02
multiplication_factor	type	number
	maximum	9999999.9999
	minimum	0.0001
energy_measurement	enum	ACT, RACT

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