Get Caloric Correction Factors

getMessages

Method	URL
POST	api/esh/get_caloric_correction_factors/get_messages

This Task wil get all available Caloric Correction Factors for the given period or GridArea from EDSN.

Input parameters

get_caloric_correction_factors get input parameters
type	object
oneOf	type	object
	properties
	grid_area	type	string
		pattern	^[0-9]{18}$
	additionalProperties	False
	type	object
	properties
	date_from	type	string
	date_to	type	string
	additionalProperties	False

EDSN validations

validation	error message	error code
The request is complete and syntactically correct	Message incomplete or syntactically incorrect	1300
Is the grid areas known?	Invalid EAN-code grid area	1308
is the grid area active?	Invalid EAN-code grid area	1304
Is the end date after the from date	Valid from date before end date	1309
Are there caloric correction factors available?	No caloric correction factors available for the selected period	1310

Return parameters

get_caloric_correction_factors get 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