Search Metering Points

search

Method	URL
POST	api/esh/search_metering_points/search

To identify a connection, a market party has a search option on the central connection register.

Input parameters

search_metering_points search input parameters
type	object
properties
ean_id	Not in combination with other search criteria
	type	string
	pattern	^[0-9]{18}$
street_name	Only in combination with house number (no wildcards; if house number is left empty, only connections are returned where no building_nr is stated)
	type	string / null
	maxLength	24
	minLength	1
building_nr	Only in combination with street_name and city_name, or with zip_code (no wildcards)
	type	integer
	maximum	99999
	minimum	1
ex_building_nr	Only in combination with building_nr, street_name and city_name, or building_nr and zip_code (no wildcards)
	type	string / null
	maxLength	6
	minLength	1
zip_code	Only in combination with city_name and building_nr (no wildcards; if building_nr is left empty, only connections are returned where no building_nr is stated)
	type	string
	maxLength	6
	minLength	1
city_name	Only in combination with street_name and building_nr (no wildcards; if building_nr is left empty, only connections are returned where no building_nr is stated)
	type	string / null
	maxLength	24
	minLength	1
country	Only in combination with house number (no wildcards; if house number is left empty, only connections are returned where no building_nr is stated)
	Netherlands, Belgium, Germany
	enum	NL, BE, DE
bag_id	Not in combination with other search criteria (no wildcards)
	type	string
	maxLength	16
	minLength	1
bag_building_id	Not in combination with other search criteria (no wildcards)
	type	string
	maxLength	16
	minLength	1
location_description	Only in combination with street_name and city_name (no wildcards)
	type	string
	maxLength	35
	minLength	1
market_segment	Filter criteria: Only in combination with at least one of the above search criteria
	Small consumption, Large consumption, Article 1 paragraph 2 or paragraph 3
	enum	KVB, GVB, ART
product_type	Filter criteria: Only in combination with at least one of the above search criteria
	enum	ELK, GAS
additionalProperties	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
At least one search criterion must be specified	No valid (combination of) search criteria	209
The requesting market party is known to the grid operator as a legal entity	EAN-code requesting party unknown	202

Output parameters

search_metering_points search return parameters
type	object
properties
message_id	Message.id
	type	string
	format	uuid
records_received	type	integer
result	type	object
	properties
	reached_max_result	type	integer
	metering_points	type	array
		items	metering_point
rejection	type	object
	properties
	grid_operator_company_id	type	string
		pattern	^[0-9]{13}$
	reasons	type	array
		items	reason

metering_point

type	object
properties
ean_id	type	string
	pattern	^[0-9]{18}$
grid_operator_company_id	type	string
	pattern	^[0-9]{13}$
grid_operator_company_name	type	string
	maxLength	255
	minLength	1
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
subtype	enum	ABR, AFV, ALG, CAI, CAM, DIV, ELP, EVE, GAR, GAS, GML, GSM, GWN, HFD, KSK, LDN, LDS, ODN, OVL, PAR, RIO, SIR, STW, SUB, TAS, VPY, VRI, WKK, WML, ZTL
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
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
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
pap_ean_id	In case of a secondary allocation point the primary allocation point
	type	string
	pattern	^[0-9]{18}$
meter_id	Only last 4 digits
	type	string
	maxLength	70
	minLength	1

reason

type	object
properties
code	see EDSN validations
	type	string
text	type	string