File Exchange Sign Off

create

Method	URL
POST	api/esh/file_exchange_sign_off/create

Creates a FileExchangeSignOff for a FileExchange.

Pre-requisite steps

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

2. If the validation of the input parameters or or the adapter validations 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: FileExchangeSignOffNotification.

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: FileExchangeSignOffAcknowledgement.

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

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

Input parameters

file_exchange_sign_off global_task input parameters
type	object
properties
file_exchange_id	FileExchange.id
	type	string
	format	uuid
reasons	type	array
	items	sign off reason

sign off reason

type	object
properties
code	type	string
text	type	string / null
additionalProperties	False

Adapter validations

validation	error message	error code
Data set is known and not signed off already?	File unknown or already signed off	247

EDSN validations

validation	error message	error code
The request to consult, a connection is complete and syntactically correct	Message incomplete or syntactically incorrect	200
Data set is known and not signed off already?	File unknown or already signed off	247
Is the recipient of the sign off/rejection the same as the sender of the dataset?	Recipient of sign off/rejection is not the same as sender of the file	248
Is the sender of the sign off/rejection the same as the recipient of the dataset?	Sender of sign off/rejection is not the same as recipient of the file	249

Output parameters

file_exchange_sign_off 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_sign_off/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_sign_off/get_data

Get data input parameters

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

Get data return parameters

file_exchange_sign_off get_data return parameters
type	object
properties
confirmation	type	object
file_exchange_sign_off_rejection	type	object
	properties
	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