Contract Cancellation

create

Method	URL
POST	api/esh/contract_cancellation/create

The purpose of this process is that the new supplier can facilitate the termination of the old contract for the customer. This is only possible on contracts that have been submitted via the weekly source file.

Pre-requisite steps

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

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

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

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

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

Create input parameters

contract_cancellation global_task input parameters
type	object
properties
ean_id	type	string
	pattern	^[0-9]{18}$
contract_cancellation_date	Date format as defined in RFC 3339, section 5.6.
	type	string
	format	date
initiator	type	string
	pattern	^[0-9]{13}$

EDSN validations

validation	error message	error code
The request to consult, a connection is complete and syntactically correct	Message incomplete or syntactically incorrect	200
Supplier is authenticated	The requesting party is not authenticated	000
Supplier is authorized	EAN-code requesting party unknown	202
Is the end date of the contract in the future??	The end date of the contract is not in the future	252
The supplier’s company EAN code is known in the supplier register	EAN-code requesting party unknown	202
The connection is known within the CER	EAN-code connection unknown	201
Does the transaction dossier of the cancellation exist?	Transaction dossier unknown	216

Create output parameters

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

Get data input parameters

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

Get data return parameters

contract_cancellation get_data return parameters
type	object
properties
update	type	object
	properties
	grid_operator_company_id	type	string
		pattern	^[0-9]{13}$
	balance_supplier_company_id	type	string
		pattern	^[0-9]{13}$
rejection	type	object
	properties
	grid_operator_company_id	type	string
		pattern	^[0-9]{13}$
	balance_supplier_company_id	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

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

sendMessages

Method	URL
POST	api/esh/contract_cancellation/send_messages

This Task wil send all available ChangeOfSupplier messages to EDSN.

Send input parameters

contract_cancellation send_messages input parameters
type	object
properties

Send return parameters

contract_cancellation send_messages return parameters
type	object
properties
message_type	type	string
message_ids	type	array
	items	EDSN message.id
		type	string
		format	uuid
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