Move In

create

Method

URL

POST

api/esh/move_in/create

The Move In process is used by a supplier to start the delivery on a connection for a customer for whom no current supplier is registered yet in the connection register.

../_images/move_in.global_task.png

Pre-requisite steps

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

  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.

Input parameters

move_in global_task input parameters

type

object

properties

  • ean_id

type

string

pattern

^[0-9]{18}$

  • grid_operator_company_id

type

string

pattern

^[0-9]{13}$

  • balance_supplier_company_id

type

string

pattern

^[0-9]{13}$

  • balance_responsible_party_company_id

type

string

pattern

^[0-9]{13}$

  • mutation_date

Date format as defined in RFC 3339, section 5.6.

type

string

format

date

  • market_segment

only used for additional validations

enum

KVB, GVB, ART

  • grid_contract_party

properties

  • initials

type

string / null

maxLength

5

minLength

1

  • surname

type

string

maxLength

24

minLength

1

  • surname_prefix

type

string / null

maxLength

4

minLength

1

additionalProperties

False

  • contact

properties

  • street_name

type

string / null

maxLength

24

minLength

1

  • building_nr

type

integer

maximum

99999

minimum

1

  • ex_building_nr

type

string / null

maxLength

6

minLength

1

  • zip_code

type

string

maxLength

6

minLength

1

  • city_name

type

string / null

maxLength

24

minLength

1

  • country

type

string / null

maxLength

2

minLength

2

additionalProperties

False

  • use_local_data_for_validation

If true then the latest available MeteringPoint data will be used to perform additional validations

type

boolean

default

False

Adapter validations

These validation will only be performed if use_local_data_for_validation is set to true or data needed for the validation is supplied in the request.

validation

error message

error code

The connection belongs to the domain of the relevant network operator

EAN-code connection unknown

201

The connection to which the request relates may not have been physically demolished

EAN-code connection unknown

201

The notification for a small-scale connection is submitted in the period 20 working days up to and including 0 working day before the change date

Incorrect submission period

210

The notification for a large-scale connection is submitted in the period 20 working days up to and including 0 working days before the change date

Incorrect submission period

210

EDSN validations

validation

error message

error code

The request to consult, a connection is complete and syntactically correct

Message incomplete or syntactically incorrect

200

The connection is known within the C-AR

EAN-code connection unknown

201

The connection belongs to the domain of the relevant network operator

EAN-code connection unknown

201

The connection to which the request relates may not have been physically demolished

EAN-code connection unknown

201

The connection point is of the normal type

EAN-code connection unknown

201

The notification for a small-scale connection is submitted in the period 20 working days up to and including 0 working day before the change date

Incorrect submission period

210

The notification for a large-scale connection is submitted in the period 20 working days up to and including 0 working days before the change date

Incorrect submission period

210

The supplier’s company EAN code is known in the supplier register

EAN-code requesting party unknown

202

Does the supplier have an active status for the product type in the market party register?

EAN-code supplier unknown

204

The program responsible company EAN code is known in the programresponsible register

EAN-code program responsible unknown

207

Does the program responsible have an active status for the product type in the market party register?

EAN-code program responsible unknown

207

It is checked that there is no intersecting process causing a rejection

Intersecting process

227

The connection is not blocked for automatic transactions

Blocked for automatic mutations

208

Output parameters

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

Get data input parameters

move_in get_data input parameters

type

object

properties

  • id

GlobalTask.id

type

string

format

uuid

Get data return parameters

move_in get_data return parameters

type

object

properties

  • gain

properties

  • mutation_date

type

string

format

date

  • grid_operator_company_id

type

string

pattern

^[0-9]{13}$

  • balance_supplier_company_id

type

string

pattern

^[0-9]{13}$

  • balance_responsible_party_company_id

type

string

pattern

^[0-9]{13}$

  • product_type

enum

ELK, GAS

  • loss

properties

  • mutation_date

type

string

format

date

  • grid_operator_company_id

type

string

pattern

^[0-9]{13}$

  • balance_supplier_company_id

type

string

pattern

^[0-9]{13}$

  • old_balance_supplier_company_id

type

string

pattern

^[0-9]{13}$

  • old_balance_responsible_party_company_id

type

string

pattern

^[0-9]{13}$

  • product_type

enum

ELK, GAS

  • rejection

properties

  • mutation_date

type

string

format

date

  • grid_operator_company_id

type

string

pattern

^[0-9]{13}$

  • balance_supplier_company_id

type

string

pattern

^[0-9]{13}$

  • balance_responsible_party_company_id

type

string

pattern

^[0-9]{13}$

  • product_type

enum

ELK, GAS

  • reasons

type

array

items

reason

  • master_data_update

properties

  • mutation_date

Date format as defined in RFC 3339, section 5.6.

type

string

format

date

  • grid_operator_company_id

type

string

pattern

^[0-9]{13}$

  • balance_supplier_company_id

type

string

pattern

^[0-9]{13}$

  • balance_responsible_party_company_id

type

string

pattern

^[0-9]{13}$

  • metering_responsible_party_company_id

type

string

pattern

^[0-9]{13}$

  • grid_area

type

string

pattern

^[0-9]{18}$

  • product_type

enum

ELK, GAS

  • metering_method

Unmeasured, Annual, Monthly, Telemetry, Not continuous, Other, Unknown

enum

OBM, JRL, MND, TMT, NCE, AND, OBK

  • profile_category

enum

E1A, E1B, E1C, E2A, E2B, E3A, E3B, E3C, E3D, E4A, OPC, G1A, G2A, G2C, GGV, GXX, GIS, GIN

  • invoice_month

type

string

pattern

^[0-1][0-9]$

  • contracted_capacity

type

integer

  • physical_capacity

type

string

maxLength

10

minLength

1

  • max_consumption

type

integer

  • cap_tar_code

type

string

pattern

^[0-9]{13}$

  • physical_status

Under construction, In operation, Out of service, Demolished

enum

IAL, IBD, UBD, SLP

  • energy_delivery_status

Inactive, Active

enum

INA, ACT

  • energy_flow_direction

Delivery, Redelivery, Combination

enum

LVR, TLV, CMB

  • market_segment

Small consumption, Large consumption, Article 1 paragraph 2 or paragraph 3

enum

KVB, GVB, ART

  • ea_energy_consumption_netted_off_peak

type

integer

maximum

999999999999999

minimum

0

  • ea_energy_consumption_netted_peak

type

integer

maximum

999999999999999

minimum

0

  • ea_energy_production_netted_off_peak

type

integer

maximum

999999999999999

minimum

0

  • ea_energy_production_netted_peak

type

integer

maximum

999999999999999

minimum

0

  • street_name

type

string

maxLength

24

minLength

1

  • building_nr

type

integer

maximum

99999

minimum

1

  • ex_building_nr

type

string

maxLength

6

minLength

1

  • zip_code

type

string

maxLength

6

minLength

1

  • city_name

type

string

maxLength

24

minLength

1

  • country

type

string

maxLength

2

minLength

2

  • location_description

type

string

maxLength

35

minLength

1

  • bag_id

type

string

maxLength

16

minLength

1

  • bag_building_id

type

string

maxLength

16

minLength

1

  • allocation_method

Telemetry, Profiled, Smart Meter Allocation

enum

TMT, PRF, SMA

  • administrative_status_smart_meter

On, Off

enum

AAN, UIT

  • meter_id

type

string

maxLength

70

minLength

1

  • meter_type

Conventional, Smart

enum

CVN, SLM

  • meter_technical_communication_sm

Technically remotely readable, Technically not remotely readable

enum

SMU, SMN

  • meter_temperature_correction

Yes, No

enum

J, N

  • meter_nr_of_registers

type

integer

maximum

9

minimum

0

  • pap_ean_id

In case of a secondary allocation point the primary allocation point

type

string

pattern

^[0-9]{18}$

  • registers

type

array

items

register

  • saps

Secondary allocation points

type

array

items

sap

  • cancellation

properties

  • process_code

Code of process which caused the cancellation

type

string

  • text

type

string

  • 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

register

properties

  • register_id

1.8.1, 1.8.2, 2.8.1, 2.8.2 or [1-9]

type

string

  • tariff_type

Total, Normal, Low

enum

T, N, L

  • metering_direction

Delivery, Redelivery

enum

LVR, TLV

  • nr_of_digits

type

integer

maximum

9

minimum

1

  • multiplication_factor

type

number

maximum

999.9999

minimum

1e-05

sap

properties

  • ean_id

type

string

pattern

^[0-9]{18}$

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/move_in/send_messages

This Task wil send all available MoveIn messages to EDSN.

Send Input parameters

move_in send_messages input parameters

type

object

properties

Send return parameters

move_in 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

send_validation

send_validation

type

object

properties

  • message

type

string

  • ref

optional reference to parameter

type

string / null

  • user_message

type

string / null