Meter Reading Dispute Notification

create

Method	URL
POST	api/esh/meter_reading_dispute_notification/create

The Dispute process for a small-scale connection is used to correct already determined meter readings.

Pre-requisite steps

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

2. If the validation of the input parameters 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: MeterReadingDisputeNotification.

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

3. The ValueA adapter collects the rejection or confirmation from EDSN: MeterReadingDisputeAcknowledgement.

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

Receiver response handling

1. The receiver validates the dispute request and sends the result to EDSN.

2. The ValueA adapter collects the results send from EDSN: MeterReadingDisputeResult.

3. When the dispute is rejected the status of the GlobalTask is set to rejected.

4. When the dispute is accepted the status of the GlobalTask is set to ready.

Input parameters

meter_reading_dispute_notification global_task input parameters
type	object
properties
meter_reading_exchange_id	MeterReadingExchange.id
	type	string
	format	uuid
comment	type	string
	maxLength	1000
	minLength	1
product_type	enum	ELK, GAS
meter_id	type	string
	maxLength	18
	minLength	1
nr_of_registers	type	integer
	maximum	9
	minimum	0
registers	type	array
	items	register
	minItems	1

register

type	object
properties
metering_direction	enum	LVR, TLV
tariff_type	enum	L, N
measure_unit	enum	KWH, M3N, MTQ
nr_of_digits	type	integer
	maximum	9
	minimum	1
readings	type	array
	items	reading
	maxItems	1
	minItems	1
additionalProperties	False

reading

type	object
properties
reading	type	integer
reading_date	type	string
	format	date
reading_method	Calculated, Agreed on, Customer/P1-reading, Physical reading, P4-reading
	enum	005, 102, 22, 003, 004
additionalProperties	False

Adapter validations

validation	error message	error code
Does the transaction dossier for the meter reading exchange exist?	Transaction dossier unknown	215

EDSN validations

validation	error message	error code
The request to consult, a connection is complete and syntactically correct	Message incomplete or syntactically incorrect	200
Does the transaction dossier for the meter reading exchange exist?	Transaction dossier unknown	215
Is the recipient known?	Recipient unknown	214

Output parameters

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

Get data input parameters

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

Get data return parameters

meter_reading_dispute_notification get_data return parameters
type	object
properties
meter_reading_dispute_result	type	object
	properties
	initiator	type	string
		pattern	^[0-9]{13}$
	consumer	type	string
		pattern	^[0-9]{13}$
	accepted	Yes, No
		enum	J, N
	comment_result	type	string
		maxLength	100
		minLength	1
	product_type	enum	ELK, GAS