Get list of Dh Valve

  • 25 minute(s) read
Prev Next
Get
/dh-valve/

Operation is used to get a list of Dh Valves.

Dh Valve data can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Query parameters
offset
integer

Offset to start returning results.

Minimum0
limit
integer

Limit number of results returned.

Minimum1
__any of the object fields__
string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

  • For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
  • For numerics: gt, lt, gte, lte, isnull
  • For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++
orderby
string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses
200

A result response object

Expand All
object
Next
string (url)

Url to next page of the list if applicable. (Null if none)

Prev
string (url)

Url to previous page of the list if applicable. (Null if none)

Results
Array of object (DhValve)

List of fetched Dh Valves

object
Address
object (Apartment)
address
object (Address)
buildingId
string

Building id

city
string

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

Building street name

streetnameAlt
string

Building street name in alternative language

streetno
string

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

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

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

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usageState
object (ApartmentStatus)

Apartment status

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

Plan
object (Plan)

Plan

Branch_line
object (DHCPDN)

District Heating Consumer Point Duct Diameter

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DH_CP_DN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Center_measure
object (DHCPDN)

District Heating Consumer Point Duct Diameter

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DH_CP_DN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Construction
object (PlanConstruction)

Plan Construction

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_CONSTRUCTION" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Excavation
object (PlanExcavation)

Plan Excavation

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_EXCAVATION" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Limiter
object (DHCPLimiter)

District Heating Consumer Point Limiter

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DH_CP_LIMITER" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Plan_piping
object (PlanPiping)

Plan Piping

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_PIPING" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

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 (DistrictArea)

District Area

location
string (ewkt)

Geographical location as EWKT representation

name
string

Name of District Area

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

Name of Plan

network
object (PlanNetworkType)

Plan Network Type

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_NETWORK_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

network_owner
object (PlanNetworkOwner)

Plan Network Owner

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_NETWORK_OWNER" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

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 (PlanPublicity)

Plan Publicity

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_PUBLICITY" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

state
object (PlanState)

Plan state

groupname

Group name of constant

Valid values[ "PLAN_STATE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

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)

Plan type

groupname

Group name of constant

Valid values[ "PLAN_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

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 (PlanWorkPhase)

Plan Work Phase

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_WORK_PHASE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

work_project
string

Work Project. Activated on request by customer.

work_type
object (PlanWorkType)

Plan Work Type

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_WORK_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

work_type_main
object (PlanWorkTypeMain)

Plan Work Type Main

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_WORK_TYPE_MAIN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

work_type_sub
object (PlanWorkTypeSub)

Plan Work Type Sub

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_WORK_TYPE_SUB" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

accuracy_id
object (SnConstants)
groupname
string

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

angle
number (float)

Angle

created_by
string

Created by

created_ts
string (date-time)

Date created

diameter
integer

Integer

dn_size_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

h_accuracy_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

history_date
string (date)

Mapping date

install_year
integer

Install year

location
string (ewkt)

Geographical location

location_accuracy
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

manhole_id
object (DhManhole)
Addres
object (Apartment)
address
object (Address)
buildingId
string

Building id

city
string

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

Building street name

streetnameAlt
string

Building street name in alternative language

streetno
string

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

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

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

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usageState
object (ApartmentStatus)

Apartment status

groupname

Group name of constant

Valid values[ "APARTMENT_STATUS" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

Plan
object (Plan)

Plan

Branch_line
object (DHCPDN)

District Heating Consumer Point Duct Diameter

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DH_CP_DN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Center_measure
object (DHCPDN)

District Heating Consumer Point Duct Diameter

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DH_CP_DN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Construction
object (PlanConstruction)

Plan Construction

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_CONSTRUCTION" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Excavation
object (PlanExcavation)

Plan Excavation

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_EXCAVATION" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Limiter
object (DHCPLimiter)

District Heating Consumer Point Limiter

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DH_CP_LIMITER" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

Plan_piping
object (PlanPiping)

Plan Piping

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_PIPING" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

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 (DistrictArea)

District Area

location
string (ewkt)

Geographical location as EWKT representation

name
string

Name of District Area

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

Name of Plan

network
object (PlanNetworkType)

Plan Network Type

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_NETWORK_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

network_owner
object (PlanNetworkOwner)

Plan Network Owner

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_NETWORK_OWNER" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

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 (PlanPublicity)

Plan Publicity

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_PUBLICITY" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

state
object (PlanState)

Plan state

groupname

Group name of constant

Valid values[ "PLAN_STATE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

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)

Plan type

groupname

Group name of constant

Valid values[ "PLAN_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

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 (PlanWorkPhase)

Plan Work Phase

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_WORK_PHASE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

work_project
string

Work Project. Activated on request by customer.

work_type
object (PlanWorkType)

Plan Work Type

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_WORK_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

work_type_main
object (PlanWorkTypeMain)

Plan Work Type Main

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_WORK_TYPE_MAIN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

work_type_sub
object (PlanWorkTypeSub)

Plan Work Type Sub

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "PLAN_WORK_TYPE_SUB" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

accuracy_id
object (SnConstants)
groupname
string

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

angle
number (float)

Angle

connection_url
string

Connection url

created_by
string

Created by

created_ts
string (date-time)

Date created

deleted
boolean

If deleted or not

dn_size_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

electricity
boolean

If electricity or not

foamed
boolean

If foamed or not

h_accuracy_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

history_date
string (date)

History date

hmit
number (float)

HMIT

id
integer

Primary key

install_year
integer

Install year

lbl_angle_exp
string

Export label angle

lbl_color_exp
string

Export label color

lbl_size_exp
string

Export size color

location
string (ewkt)

Geographical location

location_accuracy
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

manhole_id
string

Manhole identification

manhole_name
string

Manhole name

mapper
string

Mapper

mapping_method_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

net_type_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

network_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

note
string

Additional details

owner_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

pump
boolean

If pump or not

pump_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

pumped_water_amount
integer

Amount of pumped water

remote_moisture_control
boolean

If remote moisture control or not

remote_usage_mh
boolean

If manhole remote usage or not

rent_paid
integer

Rent paid

rotation
integer

location

safetyDistance
object (SafetyDistance)

Safety Distance

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant.

Valid values[ "SAFETY_DISTANCE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

scale
number (float)

Scale

sewer
boolean

If sewer connection or not

state_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

survey_amount
string

Survey amount

sym_angle_exp
string

Export symbol angle

sym_code_gt
string

Symbol code

sym_color_exp
string

Export symbol color

sym_name_exp
string

Export symbol name

sym_size_exp
string

Export symbol size

sym_text_exp
string

Export symbol text

sym_width_exp
string

Export symbol width

t_area_id
object (DhDivision)
area_id
object (DhArea)
mslink
integer

Primary key

name
string

Name

created_by
string

Creator

created_ts
string (date-time)

Date created

location
string (ewkt)

Geographical location

mslink
integer

Primary key

name
string

Name

remarks
string

Remarks

updated_by
string

Updated by

updated_ts
string (date-time)

Date updated

type_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

updated_by
string

Updated by

updated_ts
string (date-time)

Date updated

url
string

Url

z_coord1
number (float)

Lid elevation

z_coord1_estimated
boolean

If lid elevation estimated or not

z_coord2
number (float)

Bottom elevation

z_coord2_estimated
boolean

If bottom elevation estimated or not

manufacturer_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

mapper
string

Mapper

mapping_method_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

model_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

mslink
integer

Primary key

net_type_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

network_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

note
string

Additional details

open_state
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

owner_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

rotation
integer

Rotation

safetyDistance
object (SafetyDistance)

Safety Distance

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant.

Valid values[ "SAFETY_DISTANCE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

scale
number (float)

Scale

state_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

survey_amount
string

Survey amount

t_area_id
object (DhDivision)
area_id
object (DhArea)
mslink
integer

Primary key

name
string

Name

created_by
string

Creator

created_ts
string (date-time)

Date created

location
string (ewkt)

Geographical location

mslink
integer

Primary key

name
string

Name

remarks
string

Remarks

updated_by
string

Updated by

updated_ts
string (date-time)

Date updated

type_id
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

updated_by
string

Updated by

updated_ts
string (date-time)

Date updated

valve_diameter
integer

Valve diameter

valve_id
string

Identification

z_coord1
number (float)

Lid elevation

z_coord1_estimated
boolean

If lid elevation estimated or not

Total
integer

Total number of Dh Valve objects in the list

401

Authentication credentials are missing or invalid

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

Detailed description of error