Meter Reading Dispute

create

Method	URL
POST	api/esh/meter_reading_dispute/create

The Meter Reading Dispute process is used by several meter reading Tasks to handle the dispute process.

The receiver of the meter reading has a period in which he can send a dispute regarding the sent meter reading. The dispute period ends on the last calendar day of the third month following the month in which the day of the meter reading relates. The receiving party has up to 20 working days before the end of the dispute period to start a dispute.

After receiving a dispute, including an alternate meter reading, a result has to be provided (see method set in API Meter Reading Dispute Result)

Pre-requisite steps

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

2. If the validation of the create 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.

Create input parameters

meter_reading_dispute global_task input parameters
type	object
properties
meter_reading_exchange_id	type	string
	format	uuid
out_parameter_id_name	return parameter name for the GlobalTask.id, default global_task_id
	type	string
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 connection is a small consumption connection	It’s a GVB / ART connection / allocation point	264

Create output parameters

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

Get data input parameters

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

Get data return parameters

meter_reading_dispute get_data return parameters
type	object
properties
accepted	Yes, No
	enum	J, N
deadline_expired	type	boolean
error	type	object
	properties
	messsageid	ValueA Broker message.id
		type	string
		format	uuid
	validations	type	array
		items	get_data_validation

get_data_validation

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

getMessages

Method	URL
POST	api/esh/meter_reading_dispute/get_messages

This Task wil get all available MeterReadingDispute messages from EDSN.

Get messages input parameters

meter_reading_dispute get_messages input parameters
type	object
properties

Get messages return parameters

meter_reading_dispute get_messages return parameters
type	object
properties
message_type	type	string
records_received	type	integer
error	type	object
	properties
	messsageid	ValueA Broker message.id
		type	string
		format	uuid
	validations	type	array
		items	validation

validation

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