Ech Portal Opvraag

create

Method	URL
POST	api/esh/ech_portal_opvraag/create

The Global Task “ECH Portal Opvraag” is available for retrieving meter readings and consumption over the own delivery period plus 4 consecutive months for old suppliers and current supplier. The most recently determined P4/customer/physical reading, including intermediate determined unrecorded readings, prior to the delivery period is also available to the current supplier. If there are no P4/customer/physically recorded determined readings for the current supplier, then the most recently determined unrecorded reading.

The process for consulting a Metered Data for a connection at TMR follows the following scenario:

Pre-requisite steps

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

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

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

3. If the request is successful, the TMR sends the current data of the concerned connection to the requesting party via an XML response ECHPortalAntwoord.

Input parameters

ech_portal_opvraag global_task input parameters
type	object
properties
ean_id	type	string
	pattern	^[0-9]{18}$

EDSN validations

validation	error message	error code
Is the requesting party authorized?	Account <P1> not authorized	P01
Does the EAN code complies with the EAN code check?	EAN-code <EAN-code> error	A01
Is Measurement data available for connection?	No information was found for the existing connection	P20
Is or was the requesting party the current supplier on the connection?	EAN code requesting party is or was not the current supplier on the KV connection	P51
General (unexpected fault)	Unknown error	P08

Output parameters

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

Get data input parameters

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

Get data return parameters

ech_portal_opvraag get_data return parameters
type	object
properties
tmr_data	properties
	grid_area	type	string
		pattern	^[0-9]{18}$
	grid_operator_company_id	type	string
		pattern	^[0-9]{13}$
	volumes	type	array
		items	volume
	readings	type	array
		items	reading
tmr_rejection	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

volume

properties
meter_id	type	string
tariff_type	type	string
valid_from_date	type	string
	format	date
valid_to_date	type	string
	format	date
volume	type	integer
measure_unit	type	string
reading_method	type	string
calorific_corrected_volume	type	integer
calorific_corrected_volume_measure_unit	type	string
determined_party	type	string

reading

properties
meter_id	type	string
register_id	type	string
tariff_type	type	string
mutation_date	type	string
	format	date
reading	type	integer
reading_method	type	string
determined_party	type	string

reason

properties
index	type	integer
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