Tariffs Sign Off

create

Method	URL
POST	api/esh/tariffs_sign_off/create

Creates a TariffSignOff for a Tariff.

Pre-requisite steps

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

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

2. The status of the GlobalTask is set to ready.

Input parameters

tariffs_sign_off global_task input parameters
type	object
properties
query_date	type	string
	format	date
date_from	type	string
	format	date
query_id	type	string
accepted	Yes, No
	enum	J, N

Output parameters

tariffs_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

Note

There are no functional return parameters for this process so a get_data method is not available.

getStatus

Method	URL
GET	api/esh/tariffs_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