Get list of electric conduits

29 Aug 2023
14 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of electric conduits

Updated on 29 Aug 2023
14 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/el_conduits/

Operation is used to get a list of electric conduits. Available from product version 3.2.2.

Electric Conduits 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.

Min length0

limit

integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Min length1

srs

string

Coordinate system to transform location to.

Example: srs=epsg:4326

__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))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++

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.

{
  "Next": null,
  "Previous": null,
  "Results": [
    {
      "cables": [],
      "creation_date": "2019-04-23T09:38:05Z",
      "creator": "api@keypro.fi",
      "depth_class": null,
      "duct_count": null,
      "ducts": [],
      "height_accuracy": null,
      "id": 68700,
      "identification": "ABC",
      "length": 106.7,
      "location": "SRID=3067;LINESTRING Z (459543.7256747800274752 6702833.1888885004445910 0.0000000000000000, 459649.5589509597630240 6702819.9597289999946952 0.0000000000000000)",
      "location_accuracy": null,
      "mapper": "",
      "mapping_date": null,
      "mapping_method": null,
      "measure": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_MEASURE",
        "id": 305010,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/CABLE_MEASURE/",
        "logical_txt": "Kartalta",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Kartalta"
      },
      "network_area": null,
      "plan": null,
      "profile_status": null,
      "safety_distance": {
        "availability_end_ts": "2022-12-31T00:00:00Z",
        "availability_start_ts": "2022-01-01T00:00:00Z",
        "available": true,
        "groupname": "SAFETY_DISTANCE",
        "id": 2060123445,
        "list_url": "https://keylight.example.com/api/v2/txt_constants/groupname/SAFETY_DISTANCE/",
        "logical_txt": "5",
        "num_value": 5.0,
        "num_value2": 5.0,
        "num_value3": 5.0,
        "num_value4": 5.0,
        "txt": "5"
      },
      "survey_amount": "",
      "type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CONDUIT_TYPE",
        "id": 430,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/CONDUIT_TYPE/",
        "logical_txt": "Kanava",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Kanava"
      },
      "update_date": "2019-04-23T09:38:05Z",
      "updated_by": "api@keypro.fi",
      "usage_state": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CONDUIT_STATE",
        "id": 710,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/CONDUIT_STATE/",
        "logical_txt": "Käytössä",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Käytössä"
      },
      "width": null
    }
  ],
  "Total": 1
}

Expand All

object

string

Url to next page of Electric Conduits list. Null if No next page exist

string

Url to previous page of Electric Conduits list. Null if No previous page exist

Results

Array of object (ElConduit)

List of fetched Electric Conduits

object

address

string

Url to fetch related address details

angle

number

angle

creation_date

string

Creation date and time

creator

string

creator

height_accuracy

object

Height accuracy

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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["H_ACCURACY"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

integer

Primary key

identification

string

Identification

installation_year

integer

Installation year

location

string

Geographical location

location_accuracy

object

Location accuracy

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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["LOCATION_ACCURACY"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

mapper

string

mapper name

mapping_date

string

mapping date

mapping_method

object

Mapping method

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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["MAPPING_METHOD"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

network_area

object

Division

integer

Unique id of division

list_url

string

Url to fetch all divisions

location

string

Location of Division

name

string

Name of division

owner

object

Manhole owner

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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["MANHOLE_OWNER"]

integer

Unique id of constant

list_url

string

Url to fetch all constants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

plan

object

Plan

Branch_line

object

District Heating Consumer Point Duct Diameter

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

Center_measure

object

District Heating Consumer Point Duct Diameter

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

Construction

object

Plan Construction

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

Excavation

object

Plan Excavation

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

Limiter

object

District Heating Consumer Point Limiter

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

Plan_piping

object

Plan Piping

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

agreed_delivery_date

string

Agreed Delivery Date. Activated on request by customer.

area_description

string

Area Description. Activated on request by customer.

begin_date

string

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

Create Date

customer_contact_date

string

Customer Contact Date. Activated on request by customer.

description

string

Description

desired_delivery_date

string

Desired Delivery Date. Activated on request by customer.

district_area

object

District Area

location

string

Geographical location as EWKT representation

name

string

Name of District Area

duration

integer

Duration. Activated on request by customer.

expire_date

string

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

Implementation Date. Activated on request by customer.

implementation_date

string

Implementation Date. Activated on request by customer.

latest_implementation_date

string

Latest Implementation Date. Activated on request by customer.

list_url

string

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

location

string

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

Plan Network Type

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

network_owner

object

Plan Network Owner

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

offer_accepted_date

string

Offer Accepted Date. Activated on request by customer.

offer_id

string

Offer ID. Activated on request by customer.

parentplan

string

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

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

Plan Publicity

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

state

object

Plan state

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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_STATE"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

total_cost

number

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

Plan type

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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_TYPE"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

updated_by

string

Updated by

updated_date

string

Update Date

work_activities

string

Work Activities. Activated on request by customer.

work_phase

object

Plan Work Phase

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

work_project

string

Work Project. Activated on request by customer.

work_type

object

Plan Work Type

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

work_type_main

object

Plan Work Type Main

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

work_type_sub

object

Plan Work Type Sub

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

remarks

string

Remarks. Available from product version 3.2.14.

rent_paid

boolean

Is rent paid or not

renter

object

Manhole renter

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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["MANHOLE_RENTER"]

integer

Unique id of constant

list_url

string

Url to fetch all constants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

safety_distance

object

Safety Distance

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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"]

integer

Unique id of constant

list_url

string

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

survey_amount

integer

unknown

type

object

Electric Manhole type

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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["EL_MANHOLE_TYPE"]

integer

Unique id of constant

list_url

string

Url to fetch all constants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

update_date

string

Last update date time

updated_by

string

Last updater

usage_state

object

Manhole usage state

availability_end_ts

string

Ending date time for availability

availability_start_ts

string

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["MANHOLE_STATE"]

integer

Unique id of constant

list_url

string

Url to fetch all constants from this group

logical_txt

string

Logical textual value

num_value

number

Numeric value

num_value2

number

Numeric value 2

num_value3

number

Numeric value 3

num_value4

number

Numeric value 4

txt

string

Human readable textual representation

Total

integer

Total number of Electric Conduits

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

Create new electric conduit