Create new Water Branch

17 Jan 2024
15 Minutes to read
Contributors

Print
Dark
Light
PDF

Create new Water Branch

Updated on 17 Jan 2024
15 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/water-branch/

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Water Branch to be created

Expand All

object

integer

Primary key

material_type

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

node

object (WaterNode)Required

Address

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

Plan

object (Plan)

Plan

Branch_line

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)

Center_measure

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)

Construction

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)

Excavation

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)

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)

Plan_piping

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)

agreed_delivery_date

string (date-time)

Agreed Delivery Date. Activated on request by customer.

area_description

string

Area Description. Activated on request by customer.

begin_date

string (date-time)

Begin Date

construction_year

integer

Contact Name. Not shown when displaying plan details in related objects. Activated on request by customer.

contact_email

string

Contact Email Address. Activated on request by customer.

contact_name

string

Contact Name. Activated on request by customer.

contact_phone

string

Contact phone number. Activated on request by customer.

cp_identification

string

Consumer Point Identification. Activated on request by customer.

created_by

string

Created by

created_date

string (date-time)

Create Date

customer_contact_date

string (date-time)

Customer Contact Date. Activated on request by customer.

description

string

Description

desired_delivery_date

string (date-time)

Desired Delivery Date. Activated on request by customer.

district_area

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)

duration

integer

Duration. Activated on request by customer.

expire_date

string (date-time)

Expire Date

first_contact

string

First contact person for plan. Not shown when displaying plan details in related objects. Activated on request by customer.

integer

Unique id of plan

implementation_begin_end

string (date-time)

Implementation Date. Activated on request by customer.

implementation_date

string (date)

Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.

latest_implementation_date

string (date)

Latest Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.

list_url

string (url)

URL to the list of all Plans. Only shown when displaying plan details in related objects.

location

string (ewkt)

Geographical location. As EWKT representation

louhi_id

string

Louhi ID. Activated on request by customer.

modifications

string

Modifications. Not shown when displaying plan details in related objects. Activated on request by customer.

name

string Required

Name of Plan

network

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)

network_owner

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)

offer_accepted_date

string (date-time)

Offer Accepted Date. Activated on request by customer.

offer_id

string

Offer ID. Activated on request by customer.

parentplan

string (url)

URL to the plan of which the plan is part of (subplan). Available from version 3.2.24. Activated on request by customer.

plan_remark

string

Plan remark. Not shown when displaying plan details in related objects. Activated on request by customer.

plumbing_start_date

string (date-time)

Plumbing Start Date. Activated on request by customer.

property_address

string

Property address. Not shown when displaying plan details in related objects. Activated on request by customer.

publicity

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)

state

object (PlanState)Required

Plan state

groupname

Group name of constant

Valid values[ "PLAN_STATE" ]

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

total_cost

number (float)

Sum of cost for all related objects for the plan. Not shown when displaying plan details in related objects. Activated on request by customer.

type

object (PlanType)Required

Plan type

groupname

Group name of constant

Valid values[ "PLAN_TYPE" ]

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

updated_by

string

Updated by

updated_date

string (date-time)

Update Date

work_activities

string

Work Activities. Activated on request by customer.

work_phase

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)

work_project

string

Work Project. Activated on request by customer.

work_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)

work_type_main

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)

work_type_sub

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)

branch_type

object (AquaBranchType)

branchtype

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

feature

string

Aqua branch type feature

integer

Primary key

net_type

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_type

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

created_by

string

Username of the user created the node

created_ts

string (date)

Date created

fault_code

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

feature

string Required

Feature

fireplug_type

object (AquaFireplugType)

feature

string

Aqua fireplug type feature

fireplyg_type

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

integer

Primary key

firewaterstationtypes

object (AquaFirewaterstationType)

feature

string

Aqua fire water station type feature

fwstype_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

integer

Primary key

network_type

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

height_accuracy

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

history_date

string (date)

History date

hydrant_type

object (AquaHydrantType)

branchtype

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

feature

string

Aqua hydrant type feature

integer

Primary key

internal_node_id

integer

Internal node id

lbl_angle

string

Label angle

lbl_angle_exp

string

Export label angle

lbl_color

string

Label color

lbl_color_exp

string

Export label color

lbl_size

string

Label size

lbl_size_exp

string

Export label size

lid_type

object (SnLidType)Required

capacity

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

diameter

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

integer

Primary key

lid_type

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

shape

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

location

string (ewkt)

Geographical location

location_accuracy

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

manhole

object (SnManholeType)Required

diameter

integer

Diameter

integer

Primary key

material

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

net_type

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

orderno

integer

Order number

manhole_type

object (AquaManholeType)Required

feature

string

Aqua manhole type feature

integer

Primary key

lid_type

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

manhole_type

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

net_type

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_type

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

mapper

string

Mapper

mapping_method

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

measuringpoint_type

object (AquaMeasuringPointType)

feature

string

Aqua measuring point type feature

integer

Primary key

mptype

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

net_type

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_type

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

mslink

integer

Primary key

node_type

string

Node type

note

string

Additional details

object_type

object (AquaObjectType)

feature

string

Aqua object type feature

integer

Primary key

net_type

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_type

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

object_type

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

owner

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

plan_date

string (date)

Plan date

plan_number

string

Plan number

position

string

Position

pump_type

object (AquaPumpType)

feature

string

Aqua pump type feature

integer

Primary key

net_type

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_type

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

pump_type

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

removal_year

integer

Removal year

status

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

status_info

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

survey_number

integer

Survey number

sym_angle

string

Symbol angle

sym_angle_exp

string

Export symbol angle

sym_color

string

Symbol color

sym_color_exp

string

Export symbol color

sym_name

string

Symbol name

sym_name_exp

string

Export symbol name

sym_size

string

Symbol size

sym_size_exp

string

Export symbol size

sym_text

string

Symbol text

sym_text_exp

string

Export symbol text

sym_width

string

Symbol width

sym_width_exp

string

Export symbol width

updated_by

string

Username of the user updated the node

updated_ts

string (date)

Date updated

usage_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

user_id

string

User id

valve_type

object (AquaValveType)

feature

string

Aqua valve type feature

integer

Primary key

net_type

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_type

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

valve_type

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

watersource_type

object (AquaWaterSourceType)

feature

string

Aqua water source type feature

integer

Primary key

watertank_type

object (AquaWaterTankType)

feature

string

Aqua water source type feature

integer

Primary key

z_coord1

number (float)

Lid elevation

z_coord1_estimated

boolean

Lid elevation estimated

z_coord2

number (float)

Bottom elevation

z_coord2_estimated

boolean

Bottom elevation estimated

size

string

Branch size

type_id

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

Responses

201

A created Water Branch

{
  "id": [
    "12345"
  ],
  "material_type": [
    "2007101"
  ],
  "node": [
    "91234"
  ],
  "size": [
    "10"
  ],
  "type_id": [
    "27211"
  ]
}

object

Water branch object. Flat version for patch and post methods

integer

Primary key

material_type

integer

Material type id

node

integer

Water node id

size

string

Branch size

type_id

integer

Branch type id

400

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

{
  "node": [
    "This field is required."
  ],
  "type_id": [
    "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

Delete Water Branch