Create new Water Duct
- 17 Jan 2024
- 11 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Create new Water Duct
- Updated on 17 Jan 2024
- 11 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/water-duct/
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
Water Duct to be created
object
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
id
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" ]
id
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" ]
id
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
id
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" ]
id
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" ]
id
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" ]
id
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
ConditionClass
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
object (Plan)
Plan
Branch_line
object (TxtConstant)
groupname
string Required
Group name of constant. Same as groupname parameter.
id
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.
id
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.
id
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.
id
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.
id
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.
id
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.
id
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.
id
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.
id
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.
id
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.
id
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" ]
id
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" ]
id
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.
id
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.
id
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.
id
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.
id
integer Required
Unique id of constant
logical_txt
string Required
Logical textual value
txt
string Required
Human readable textual representation (translated)
Type
object (DuctType)Required
FormCode
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
SeparationMark
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
integer
Duct diameter
diameter_id
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
firmness_class
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
id
integer
Primary key
inner_diameter
number (float)
Duct inner diameter
material
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
material_abbreviation
string
Material abbreviation
material_txt
string
Material text
net_type
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
outdated_date
string (date)
Outdated date
presentation_date
string (date)
Presentation date
pressure_class
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
technical_lifespan
integer
Technical lifespan in years
width
integer
Duct width
begin_z_coord
number (float)
Z-coordinate of the beginning point
begin_z_estimated
boolean
An indicator if the beginning point's z-coordinate is only an estimate
build_year
integer
Build year
condition_idx
integer
Condition index
connected_duct
integer
Connected duct ID
created_by
string
Created by
created_ts
string (date)
Date created
critical_index
integer
Critical index
duct_type
object (AquaDuctType)Required
duct_type
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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 duct type feature
id
integer
Primary key
net_type
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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.
id
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
end_z_coord
number (float)
Z-coordinate of the end point
end_z_estimated
boolean
An indicator if the end point's z-coordinate is only an estimate
epanet_mloss
number (float)
Minor losses
epanet_roughness
number (float)
Roughness coefficient
epanet_status
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
estimated_condition
integer
Estimated condition
feature
string
Feature
height_accuracy
object (SnConstants)
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
install_location
object (SnConstants)Required
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
landxml_name
string
Landxml name
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
length
number (float)
3D length
length_2d
number (float)
2D length
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.
id
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.
id
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
note
string
Additional details
owner
object (SnConstants)Required
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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
integer
Plan number
removal_year
integer
Removal year
risk_index
integer
Risk index
state
object (SnConstants)Required
groupname
string Required
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
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_code_gt
string
Symbol code gt
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
Updated by
updated_ts
string (date)
Date updated
user_id
string
User's ID
verbal_condition_info
string
Condition info
z_coord
string
Z-coordinate
Responses
201
A newly created Water Duct
object
Address
integer
Address Id
ConditionClass
integer
Condition Class Id
Plan
integer
Plan Id
Type
integer
Type Id
begin_z_coord
number (float)
Z-coordinate of the beginning point
begin_z_estimated
boolean
An indicator if the beginning point's z-coordinate is only an estimate
build_year
integer
Build year
condition_idx
integer
Condition index
connected_duct
number (float)
Connected duct ID
created_by
string
Created by
created_ts
string (date)
Date created
critical_index
integer
Critical index
duct_type
integer
Duct Type Id
end_z_coord
number (float)
Z-coordinate of the end point
end_z_estimated
boolean
An indicator if the end point's z-coordinate is only an estimate
epanet_mloss
number (float)
Minor losses
epanet_roughness
number (float)
Roughness coefficient
epanet_status
integer
Epanet Status Id
estimated_condition
integer
Estimated condition
feature
string
Feature
height_accuracy
integer
Height Accuracy Id
history_date
string (date)
History date
install_location
integer
Install Location Id
landxml_name
string
Landxml name
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
length
number (float)
3D length
length_2d
number (float)
2D length
location
string (ewkt)
Geographical location
location_accuracy
integer
Location Accuracy Id
mapper
string
Mapper
mapping_method
integer
Mapping Method Id
mslink
integer
Primary key
note
string
Additional details
owner
integer
Owner Id
plan_date
string (date)
Plan date
plan_number
integer
Plan number
removal_year
integer
Removal year
risk_index
integer
Risk index
state
integer
State Id
survey_number
integer
Survey number
sym_angle
string
Symbol angle
sym_angle_exp
string
Export symbol angle
sym_code_gt
string
Symbol code gt
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
Updated by
updated_ts
string (date)
Date updated
user_id
string
User's ID
verbal_condition_info
string
Condition info
z_coord
string
Z-coordinate
400
There was an error in request. Usually field validation failed.
{
"flow_number": [
"This field is required."
],
"install_date": [
"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?
