Create new Consumer Point Connection

17 Jan 2024
7 Minutes to read
Contributors

Print
Dark
Light
PDF

Create new Consumer Point Connection

Updated on 17 Jan 2024
7 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/consumer-points-connection/

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Consumer Point Connection to be created

Expand All

object

ContentType

object (ContentType)Required

integer

Primary key

identifier

string

Object type readable identifier

instanceAPIUrl

string (url)

Object type instances API endpoint URL

name

string

Object type translated name. Not searchable.

objectTypesUrl

string (url)

Object types API endpoint URL

Cp_id

object (ConsumerPoint)Required

Consumer point object

Address

object (Address)

buildingId

string

Building id

city

string Required

Building city name

cityAlt

string

Building city name in alternative language

country

string

Building country

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

district

string

Building district

integer

Primary key

location

string (ewkt)

Geographical location

municipality

string

Building municipality

propertyId

string

Property number

province

string

Building province

streetname

string Required

Building street name

streetnameAlt

string

Building street name in alternative language

streetno

string Required

Building number

subdivision

string

Building municipality subdivision

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usagePurpose

object (BuildingUsage)

Building usage purpose

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]

integer Required

Unique id of constant

list_url

string (url) Required

Url to fetch all contants from this group

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer Required

Unique id of constant

list_url

string (url) Required

Url to fetch all contants from this group

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation

zipcode

string

Building zipcode

Addresses

object (Apartment)

address

object (Address)Required

buildingId

string

Building id

city

string Required

Building city name

cityAlt

string

Building city name in alternative language

country

string

Building country

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

district

string

Building district

integer

Primary key

location

string (ewkt)

Geographical location

municipality

string

Building municipality

propertyId

string

Property number

province

string

Building province

streetname

string Required

Building street name

streetnameAlt

string

Building street name in alternative language

streetno

string Required

Building number

subdivision

string

Building municipality subdivision

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usagePurpose

object (BuildingUsage)

Building usage purpose

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]

integer Required

Unique id of constant

list_url

string (url) Required

Url to fetch all contants from this group

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer Required

Unique id of constant

list_url

string (url) Required

Url to fetch all contants from this group

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation

zipcode

string

Building zipcode

apartmentDivision

string

apartment division

apartmentLetter

string

apartment letter

apartmentNumber

string

apartment number

integer

Primary key

originProperty

string

apartment original property id

originalStreetno

string

apartment original streen number

usagePurpose

object (ApartmentUsage)

Apartment Usage purpose

groupname

Group name of constant

Valid values[ "APARTMENT_USAGE" ]

integer Required

Unique id of constant

list_url

string (url) Required

Url to fetch all contants from this group

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation

usagePurposeAlt

object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]

integer Required

Unique id of constant

list_url

string (url) Required

Url to fetch all contants from this group

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation

usageState

object (ApartmentStatus)

Apartment status

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]

integer Required

Unique id of constant

list_url

string (url) Required

Url to fetch all contants from this group

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation

Group

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

Interesting_id

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

Network_node

integer

Unique Id for water node connected to consumer point

angle

number (float)

Angle rotation of the consumer point object

asbest_ceiling

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

asbest_corridor

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

asbest_room

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

build_year

integer

Build year

comments

string

Remarks

consumer_name

string

Consumer name GDPR protected field

consumer_name_ext

string

Consumer name extension GDPR protected field

consumer_number

string Required

Water number

cp_state

object (SnConstants)Required

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

cp_type

object (SnConstants)Required

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

createdBy

string

User that created the object

createdTs

string (date-time)

Creation date and time

critical_customer

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

critical_customer_remarks

string

Remarks

dh_building_volume

number (float)

District sheating building volume

dh_construction_year

integer

Construction year

dh_dn

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

dh_limiter

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

dh_number

string

District heating number

dh_power

number (float)

District heating power

dh_room_count

string

Building / Room count

dh_water_flow

number (float)

District heating water flow

duct_size_dn

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

elevation

number (float)

Connection elevation value

final_approval_date

string (date-time)

Final approval date

gas_burner_power

integer

Gas burner power

gas_connecting_power

integer

Gas connecting power

gas_device_power

integer

Gas device power

gas_number

string

Gas number

gas_pressure_controller

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

gas_supply_pressure

integer

Gas supply pressure

gsrn_id

string

GSRN ID

heating_form

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

hot_water_dim_flow

number (float)

Hot water measurement flow

integer

Primary key

identification

string

Identification name for the consumer point object

industrial_contact_email

string

Industrial contact email GDPR protected field

industrial_contact_info

string

Industrial contact info GDPR protected field

industrial_contact_name

string

Industrial contact name GDPR protected field

industrial_contact_phone

string

Industrial contact number GDPR protected field

industrial_waste_water_contract

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

joining_date

string (date-time)

Last update date time

location

string (ewkt)

Geographical location

name_extend

string

Consumer name extension

network_number

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

real_estate_info

string

Real estate info GDPR protected field

real_estate_name

string

Real estate name GDPR protected field

residents

integer

Number of residents

restricted_type

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

scale

number (float)

Scale of map object

sewer_junction

boolean

Specifies if consumer point is a sewer junction

sprinkler_contact_email

string

Sprinkler contact email GDPR protected field

sprinkler_contact_info

string

Sprinkler contact info GDPR protected field

sprinkler_contact_name

string

Sprinkler contact name GDPR protected field

sprinkler_contact_phone

string

Sprinkler contact number GDPR protected field

sprinkler_customer

object (SnConstants)

groupname

string Required

Group name of constant. Group name must contain only uppercase letters separated by underscores.

integer

Primary key

num_value

integer

Numerical value of the constant

orderno

integer

Order number

txt

string

Human readable textual representation

txt_2

string

Human readable textual representation

value

string

Logical textual value

storm_water_junction

boolean

Specifies if consumer point is a storm junction

type

object (TxtConstant)

groupname

string Required

Group name of constant. Same as groupname parameter.

integer Required

Unique id of constant

logical_txt

string Required

Logical textual value

txt

string Required

Human readable textual representation (translated)

updatedBy

string

Last user that updated the record

updatedTs

string (date-time)

Last update date time

water_base_af

string

Water base annual fee

water_db_id

integer

Water database id

water_junction

boolean

Specifies if consumer point is a water junction

integer

Primary key

network

string

Network

object_id

string Required

Object id

Responses

201

A newly created Consumer Point Connection

{
  "ContentType": [
    "80"
  ],
  "id": [
    "12345"
  ],
  "network": [
    "water"
  ],
  "object_id": [
    "54321"
  ]
}

object

Consumer point connection object. Flat version for patch and post methods

ContentType

integer

Content type id

Cp_id

integer

Consumer point id

integer

Primary key

network

string

Network

object_id

integer

Object id

400

There was an error in request. Usually field validation failed.

{
  "ContentType": [
    "This field is required."
  ],
  "Cp_id": [
    "This field is required."
  ],
  "object_id": [
    "This field is required."
  ]
}

object

Fields which failed validation

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Delete Consumer Point Connection