File Exchange Notification

create

Method	URL
POST	api/esh/file_exchange_notification/create

The process for offering datasets via the service File Exchange consists of three steps:

1. Offering a dataset (via SFTP);

2. Notifying that a dataset is available;

3. Processing the result (that a dataset has been successfully processed or rejected by the recipient).

Pre-requisite steps

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

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

Global Task steps

1. The ValueA adapter sends out the request to EDSN via an XML request: FileExchangeNotification.

2. EDSN validates the request (see EDSN validations). If there are inaccuracies, the message is rejected otherwise a confirmation is send via an XML response: FileExchangeAcknowledgement.

3. When a rejection is received the status of the GlobalTask is set to rejected.

4. The recipient validates the received file. If there are inaccuracies, the file is rejected otherwise a confirmation is send via an XML response: FileExchangeResultResponse.

5. When a rejection is received the status of the GlobalTask is set to rejected.

6. When a confirmation is received the status of the GlobalTask is set to ready.

Input parameters

file_exchange_notification global_task input parameters
type	object
properties
market_party_from	type	string
	pattern	^[0-9]{13}$
market_party_to	type	string
	pattern	^[0-9]{13}$
file_name	type	string
	maxLength	100
	minLength	1
file_sort	see File types
	enum	OBLGTN, CNTRCT, RESCNT, MTPEXT, BULKPV, SEBREP, MSTDTA, GAIN, LOSS, REJECTION, PROREP, CONNDTA, RCPTE, RCPTG, CALVAL, RROM, RCPTAL, KSAEXT, MAEXT, MSTDTG, SUMEAC
note	type	string / null
	maxLength	100
	minLength	1
hash	MD5hash of the file
	type	string
	pattern	^([^:]+:[a-fA-F0-9]+|[a-fA-F0-9]{32}|)$
sftp_location	type	string
	maxLength	1000
	minLength	1

File types

code	description
OBLGTN	Verplichting
CNTRCT	Contract (CER)
RESCNT	Resultaat aanleveren contract (CER)
MTPEXT	Extract aansluitingen
BULKPV	Bulk PV-switch
SEBREP	Restverdeling Leveringszekerheid
MSTDTA	Stamgegevens
GAIN	Gain (tbv Bulk PV-switch en Leveringszekerheid)
LOSS	Loss (tbv Bulk PV-switch en Leveringszekerheid)
REJECTION	Afwijzing (tbv Bulk PV-switch en Leveringszekerheid)
PROREP	Verwerkingsverslag Bulk PV-switch
CONNDTA	RNB bulk notificaties
RCPTE	Kassabon elektriciteit
RCPTG	Kassabon gas
CALVAL	Calorische waarden
RROM	RNB Rapportage ODA Mandaat
RCPTAL	Allocatiebon elektriciteit
KSAEXT	Extract klantsleutels
MAEXT	Extract mijnaansluitingen.nl
MSTDTG	Stamgegevens bij GAIN
SUMEAC	Sommatie SJA en SJI

EDSN validations

validation	error message	error code
The request to consult, a connection is complete and syntactically correct	Message incomplete or syntactically incorrect	200
Is the sender known?	Sender unknown	243
Is the recipient known?	Recipient unknown	214
Is the file type known?	File type unknown	244

Output parameters

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

Get data input parameters

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

Get data return parameters

file_exchange_notification get_data return parameters
type	object
properties
file_exchange_acknowledgement	type	object
	properties
	file_id	type	string
		maxLength	40
		minLength	1
	external_reference	type	string
		maxLength	60
		minLength	1
	reasons	type	array
		items	reason
file_exchange_result	type	object
	properties
	file_id	type	string
		maxLength	40
		minLength	1
	market_party_from	type	string
		pattern	^[0-9]{13}$
	market_party_to	type	string
		pattern	^[0-9]{13}$
	reasons	type	array
		items	reason
error	type	object
	properties
	messsageid	ValueA Broker message.id
		type	string
		format	uuid
	validations	type	array
		items	get_data_validation

reason

type	object
properties
code	type	string
text	type	string

get_data_validation

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