Loss

getMessages

Method	URL
POST	api/esh/loss/get_messages

This Task wil get all available Loss messages from EDSN. If a Loss is received because of a Change Of Supplier or Move In, the outstanding Tasks Move Out and End Of Supply for that connection will be cancelled.

Input parameters

loss get_messages input parameters
type	object
properties

Return parameters

loss get_messages return parameters
type	object
properties
message_type	type	string
records_received	type	integer
records_processed	type	integer
processes_cancelled	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

eventMessageCollector

Method	URL
POST	api/esh/loss/event_message_collector

This Task wil get all event based Loss messages from EDSN.

Input parameters

loss event_message_collector input parameters
type	object
properties
from_date_time	Date-time format as defined in RFC 3339, section 5.6.
	type	string
	format	date-time
batch_size	Maximum number of messages to be fetched, because minimum timespan is 1 second it can return more records then requested
	type	integer
	default	1000

Return parameters

loss event_message_collector return parameters
type	object
properties
to_date_time	type	string
	format	date-time
records_received	type	integer
messages	type	array
	items	loss_message
error	type	object
	properties
	messsageid	ValueA Broker message.id
		type	string
		format	uuid
	validations	type	array
		items	collector_validation

loss_message

type	object
properties
ean_id	type	string
	pattern	^[0-9]{18}$
mutation_date	type	string
	format	date
grid_operator_company_id	type	string
	pattern	^[0-9]{13}$
balance_supplier_company_id	type	string
	pattern	^[0-9]{13}$
old_balance_supplier_company_id	type	string
	pattern	^[0-9]{13}$
old_balance_responsible_party_company_id	type	string
	pattern	^[0-9]{13}$
product_type	enum	ELK, GAS

collector_validation

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