Historical Metering Data

create

Method	URL
POST	api/esh/historical_metering_data/create

Market parties that have an authorization from the affiliated party can request historical measurement data from the grid operator. For large-scale connections, the supplier can request historical measurement data. In the Historical Metering Data process the supplier is called the requesting market party. The requesting market party must be able to submit the authorization on request if it is not already the active market party on that connection.

Pre-requisite steps

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

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

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

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

Grid Operator response handling

1. The Grid Operator validates the request (see Grid Operator validations). If there are inaccuracies, the message is rejected, otherwise the historical metering data is returned.

2. The ValueA adapter can collect the rejections send by the Grid Operator, if available, from EDSN: Historical Metering Data Rejection (method get_messages).

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

4. The ValueA adapter can collect the results send by the Grid Operator, if available, from EDSN: Meter Reading Exchange (method get_messages).

5. The status of the GlobalTask is set to ready.

Input parameters

historical_metering_data global_task input parameters
type	object
properties
ean_id	type	string
	pattern	^[0-9]{18}$
product_type	enum	ELK, GAS
date_from	type	string
	format	date
date_to	type	string
	format	date
consumer	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
Is the recipient known?	Recipient unknown	214

Grid Operator 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 network operator	EAN-code connection unknown	201
The requesting market party is known to the grid operator as a legal entity	EAN-code requesting party unknown	202
Is historical measurement data available?	No historical measurement data available	241
Is the connection an small-scale connection?	Connection is not a small-scale consumption connection	242

Output parameters

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

Get data input parameters

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

Get data return parameters

historical_metering_data get_data return parameters
type	object
properties
meter_reading_exchange	type	object
	properties
	consumer	type	string
		pattern	^[0-9]{13}$
	initiator	type	string
		pattern	^[0-9]{13}$
	valid_from_date	type	string
		format	date
	valid_to_date	type	string
		format	date
	product_type	enum	ELK, GAS
	volumes	type	array
		items	volume
historical_metering_data_rejection	type	object
	properties
	initiator	type	string
		pattern	^[0-9]{13}$
	consumer	type	string
		pattern	^[0-9]{13}$
	product_type	enum	ELK, GAS
	code	see Grid Operator validations
		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

volume

type	object
properties
valid_from_date	type	string
	format	date
valid_to_date	type	string
	format	date
volume	type	string
	maxLength	15
	minLength	1
calorific_corrected_volume	type	string
	maxLength	15
	minLength	1
registers	type	array
	items	register
	maxItems	1
	minItems	0
readings	type	array
	items	#/$defs/reading
	maxItems	2
	minItems	0

register

type	object
properties
metering_direction	enum	LVR, TLV
tariff_type	enum	L, N

get_data_validation

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