Contents x
    Create new consumer point.
    • 17 Jan 2024
    • 5 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Create new consumer point.

    • Updated on 17 Jan 2024
    • 5 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /consumer-points/
    Security
    API Key
    Header parameter nameAuthorization

    Token issued for API consumer.

    Body parameters

    Consumer Point data to be saved.

    object

    Consumer point object. Flat version for patch and post methods

    Address
    integer

    Consumer point main address ID

    Addresses
    integer

    Consumer point connected addresses ID

    Group
    integer

    Consumer point group ID. Possible values are configured in SnConstants under 'CONSUMERPOINT_GROUP' groupname

    Interesting_id
    integer

    Interesting ID

    Network_node
    integer

    Unique Id for water node connected to consumer point

    angle
    number (float)

    Angle rotation of the consumer point object

    asbest_ceiling
    integer

    ID that specifies presence of asbest in the room. Possible values are configured in SnConstants under 'CONSUMERPOINT_ASBEST' groupname

    asbest_corridor
    integer

    ID that specifies presence of asbest in the coriddor. Possible values are configured in SnConstants under 'CONSUMERPOINT_ASBEST' groupname

    asbest_room
    integer

    ID that specifies presence of asbest in the room. Possible values are configured in SnConstants under 'CONSUMERPOINT_ASBEST' groupname

    build_year
    integer

    Build year

    comments
    string

    Remarks

    consumer_name
    string

    Consumer name

    consumer_name_ext
    string

    Consumer name extension

    consumer_number
    string Required

    Water number

    cp_state
    integer Required

    Consumer point state. Possible values are configured in SnConstants under 'CONSUMERPOINT_STATE' groupname

    cp_type
    integer Required

    Consumer point type. Possible values are configured in SnConstants under 'CONSUMER_POINT_TYPE' groupname

    createdBy
    string

    User that created the object

    createdTs
    string (date-time)

    Creation date and time

    critical_customer
    integer

    ID that specifies if consumer point is for a critical customer. Possible values are configured in SnConstants under 'CRITICAL_CUSTOMER' groupname

    critical_customer_remarks
    string

    Remarks

    dh_building_volume
    number (float)

    District heating building volume

    dh_construction_year
    integer

    Construction year

    dh_dn
    integer

    District heating measure center DN ID. Possible values are configured in TxtConstants under 'DH_CP_DN' groupname

    dh_limiter
    integer

    District heating limiter type ID. Possible values are configured in TxtConstants under 'DH_CP_LIMITER' groupname

    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
    integer

    Branch line DN ID. Possible values are configured in TxtConstants under 'DH_CP_DN' groupname

    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
    integer

    Gas pressure controller. Possible values are configured in SnConstants under 'GAS_PRESSURE_CONTROL' groupname

    gas_supply_pressure
    integer

    Gas supply pressure

    gsrn_id
    string

    GSRN ID

    heating_form
    integer

    Heating form

    hot_water_dim_flow
    number (float)

    Hot water measurement flow

    id
    integer

    Primary key

    identification
    string

    Identification name for the consumer point object

    industrial_contact_email
    string

    Industrial contact email

    industrial_contact_info
    string

    Industrial contact info

    industrial_contact_name
    string

    Industrial contact name

    industrial_contact_phone
    string

    Industrial contact number

    industrial_waste_water_contract
    integer

    Industrial waste ID. Possible values are configured in SnConstants under 'INDUSTRIAL_WW_CONT' groupname

    joining_date
    string (date-time)

    Last update date time

    location
    string (ewkt)

    Geographical location

    name_extend
    string

    Consumer name extension

    network_number
    integer

    Network number ID. Possible values are configured in TxtConstants under 'NETWORK_NUMBER' groupname

    real_estate_info
    string

    Real estate info

    real_estate_name
    string

    Real estate name

    residents
    integer

    Number of residents

    restricted_type
    integer

    ID that specifies restriction type of consumer point record. Possible values are configured in TxtConstants under 'CONSUMERPOINT_GROUP' groupname

    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

    sprinkler_contact_info
    string

    Sprinkler contact info

    sprinkler_contact_name
    string

    Sprinkler contact name

    sprinkler_contact_phone
    string

    Sprinkler contact number

    sprinkler_customer
    integer

    ID that specifies if consumer point is for a sprinkler customer. Possible values are configured in SnConstants under 'SPRINKLER_CUSTOMER' groupname

    storm_water_junction
    boolean

    Specifies if consumer point is a storm junction

    type
    integer

    Subscription type ID. Possible values are configured in TxtConstants under 'CP_TYPE' groupname

    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

    Responses
    201

    Consumer Point created successfully.

    object

    Consumer point object. Flat version for patch and post methods

    Address
    integer

    Consumer point main address ID

    Addresses
    integer

    Consumer point connected addresses ID

    Group
    integer

    Consumer point group ID. Possible values are configured in SnConstants under 'CONSUMERPOINT_GROUP' groupname

    Interesting_id
    integer

    Interesting ID

    Network_node
    integer

    Unique Id for water node connected to consumer point

    angle
    number (float)

    Angle rotation of the consumer point object

    asbest_ceiling
    integer

    ID that specifies presence of asbest in the room. Possible values are configured in SnConstants under 'CONSUMERPOINT_ASBEST' groupname

    asbest_corridor
    integer

    ID that specifies presence of asbest in the coriddor. Possible values are configured in SnConstants under 'CONSUMERPOINT_ASBEST' groupname

    asbest_room
    integer

    ID that specifies presence of asbest in the room. Possible values are configured in SnConstants under 'CONSUMERPOINT_ASBEST' groupname

    build_year
    integer

    Build year

    comments
    string

    Remarks

    consumer_name
    string

    Consumer name

    consumer_name_ext
    string

    Consumer name extension

    consumer_number
    string

    Water number

    cp_state
    integer

    Consumer point state. Possible values are configured in SnConstants under 'CONSUMERPOINT_STATE' groupname

    cp_type
    integer

    Consumer point type. Possible values are configured in SnConstants under 'CONSUMER_POINT_TYPE' groupname

    createdBy
    string

    User that created the object

    createdTs
    string (date-time)

    Creation date and time

    critical_customer
    integer

    ID that specifies if consumer point is for a critical customer. Possible values are configured in SnConstants under 'CRITICAL_CUSTOMER' groupname

    critical_customer_remarks
    string

    Remarks

    dh_building_volume
    number (float)

    District heating building volume

    dh_construction_year
    integer

    Construction year

    dh_dn
    integer

    District heating measure center DN ID. Possible values are configured in TxtConstants under 'DH_CP_DN' groupname

    dh_limiter
    integer

    District heating limiter type ID. Possible values are configured in TxtConstants under 'DH_CP_LIMITER' groupname

    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
    integer

    Branch line DN ID. Possible values are configured in TxtConstants under 'DH_CP_DN' groupname

    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
    integer

    Gas pressure controller. Possible values are configured in SnConstants under 'GAS_PRESSURE_CONTROL' groupname

    gas_supply_pressure
    integer

    Gas supply pressure

    gsrn_id
    string

    GSRN ID

    heating_form
    integer

    Heating form

    hot_water_dim_flow
    number (float)

    Hot water measurement flow

    id
    integer

    Primary key

    identification
    string

    Identification name for the consumer point object

    industrial_contact_email
    string

    Industrial contact email

    industrial_contact_info
    string

    Industrial contact info

    industrial_contact_name
    string

    Industrial contact name

    industrial_contact_phone
    string

    Industrial contact number

    industrial_waste_water_contract
    integer

    Industrial waste ID. Possible values are configured in SnConstants under 'INDUSTRIAL_WW_CONT' groupname

    joining_date
    string (date-time)

    Last update date time

    location
    string (ewkt)

    Geographical location

    name_extend
    string

    Consumer name extension

    network_number
    integer

    Network number ID. Possible values are configured in TxtConstants under 'NETWORK_NUMBER' groupname

    real_estate_info
    string

    Real estate info

    real_estate_name
    string

    Real estate name

    residents
    integer

    Number of residents

    restricted_type
    integer

    ID that specifies restriction type of consumer point record. Possible values are configured in TxtConstants under 'CONSUMERPOINT_GROUP' groupname

    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

    sprinkler_contact_info
    string

    Sprinkler contact info

    sprinkler_contact_name
    string

    Sprinkler contact name

    sprinkler_contact_phone
    string

    Sprinkler contact number

    sprinkler_customer
    integer

    ID that specifies if consumer point is for a sprinkler customer. Possible values are configured in SnConstants under 'SPRINKLER_CUSTOMER' groupname

    storm_water_junction
    boolean

    Specifies if consumer point is a storm junction

    type
    integer

    Subscription type ID. Possible values are configured in TxtConstants under 'CP_TYPE' groupname

    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

    400

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

    {
  "consumer_number": [
    "This field is required."
  ],
  "cp_type": [
    "This field is required."
  ]
}

    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
    Products
    Company
    Our Mission
    Connect With Us
    Support
    Copyright © Keypro Oy. All Rights Reserved