Master Data Update

getMessages

Method	URL
POST	api/esh/master_data_update/get_messages

This Task wil get all available MasterDataUpdate messages from EDSN. In case of a Master Data Update for a connection which the Grid operator has indicated that it was demolished the outstanding Tasks Change Of Supplier, Move In, Move Out, End Of Supply and Change Of PV (program responsible) for that connection will be cancelled.

Input parameters

master_data_update get_messages input parameters
type	object
properties

Return parameters

master_data_update 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/master_data_update/event_message_collector

This Task wil get all event based MasterDataUpdate 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	master_data_update_message
error	type	object
	properties
	messsageid	ValueA Broker message.id
		type	string
		format	uuid
	validations	type	array
		items	collector_validation

master_data_update_message

properties
mutation_date	Date format as defined in RFC 3339, section 5.6.
	type	string
	format	date
grid_operator_company_id	type	string
	pattern	^[0-9]{13}$
balance_supplier_company_id	type	string
	pattern	^[0-9]{13}$
balance_responsible_party_company_id	type	string
	pattern	^[0-9]{13}$
metering_responsible_party_company_id	type	string
	pattern	^[0-9]{13}$
grid_area	type	string
	pattern	^[0-9]{18}$
product_type	enum	ELK, GAS
metering_method	Unmeasured, Annual, Monthly, Telemetry, Not continuous, Other, Unknown
	enum	OBM, JRL, MND, TMT, NCE, AND, OBK
profile_category	enum	E1A, E1B, E1C, E2A, E2B, E3A, E3B, E3C, E3D, E4A, OPC, G1A, G2A, G2C, GGV, GXX, GIS, GIN
invoice_month	type	string
	pattern	^[0-1][0-9]$
contracted_capacity	type	integer
physical_capacity	type	string
	maxLength	10
	minLength	1
max_consumption	type	integer
cap_tar_code	type	string
	pattern	^[0-9]{13}$
physical_status	Under construction, In operation, Out of service, Demolished
	enum	IAL, IBD, UBD, SLP
energy_delivery_status	Inactive, Active
	enum	INA, ACT
energy_flow_direction	Delivery, Redelivery, Combination
	enum	LVR, TLV, CMB
market_segment	Small consumption, Large consumption, Article 1 paragraph 2 or paragraph 3
	enum	KVB, GVB, ART
ea_energy_consumption_netted_off_peak	type	integer
	maximum	999999999999999
	minimum	0
ea_energy_consumption_netted_peak	type	integer
	maximum	999999999999999
	minimum	0
ea_energy_production_netted_off_peak	type	integer
	maximum	999999999999999
	minimum	0
ea_energy_production_netted_peak	type	integer
	maximum	999999999999999
	minimum	0
street_name	type	string
	maxLength	24
	minLength	1
building_nr	type	integer
	maximum	99999
	minimum	1
ex_building_nr	type	string
	maxLength	6
	minLength	1
zip_code	type	string
	maxLength	6
	minLength	1
city_name	type	string
	maxLength	24
	minLength	1
country	type	string
	maxLength	2
	minLength	2
location_description	type	string
	maxLength	35
	minLength	1
bag_id	type	string
	maxLength	16
	minLength	1
bag_building_id	type	string
	maxLength	16
	minLength	1
allocation_method	Telemetry, Profiled, Smart Meter Allocation
	enum	TMT, PRF, SMA
administrative_status_smart_meter	On, Off
	enum	AAN, UIT
meter_id	type	string
	maxLength	70
	minLength	1
meter_type	Conventional, Smart
	enum	CVN, SLM
meter_technical_communication_sm	Technically remotely readable, Technically not remotely readable
	enum	SMU, SMN
meter_temperature_correction	Yes, No
	enum	J, N
meter_nr_of_registers	type	integer
	maximum	9
	minimum	0
pap_ean_id	In case of a secondary allocation point the primary allocation point
	type	string
	pattern	^[0-9]{18}$
registers	type	array
	items	#/$defs/register
saps	Secondary allocation points
	type	array
	items	#/$defs/sap

collector_validation

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