Get list of telecom manholes

28 Oct 2024
9 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of telecom manholes

Updated on 28 Oct 2024
9 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/manholes/

Operation is used to get a list of telecom manholes. Available from product version 3.2.8.

Manholes list 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. 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.

Minimum1

srs

string

Coordinate system to transform location to.

Example: srs=epsg:4326

precision

integer

Number of decimals to be returned with object location. If parameter is not specified the number of decimals is as precise as possible for current running instance. Available from product version 2024.4.

Minimum1

dimensions

integer

number of dimensions to be returned. Acceptable values are 2 and 3. If parameter is not specified the number of dimensions are as default for current product. Available from product version 2024.4.

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))+++ 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": "https://example.keycom.fi/api/v2/manholes/?limit=3&offset=6&orderby=id",
  "Previous": "https://example.keycom.fi/api/v2/manholes/?limit=3&orderby=id",
  "Results": [
    {
      "address": "https://example.keycom.fi/api/v2/apartments/7179/",
      "angle": 88.39442279936954,
      "createdBy": "",
      "createdTs": null,
      "diagramConfirm": null,
      "heightAccuracy": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "H_ACCURACY",
        "id": 117210,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/H_ACCURACY/",
        "logical_txt": "Ei määritelty",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Ei määritelty"
      },
      "historyDate": null,
      "id": 70,
      "identification": "",
      "installYear": null,
      "location": "SRID=3067;POINT Z (457538.6286 6702986.758 0)",
      "locationAccuracy": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "LOCATION_ACCURACY",
        "id": 8301,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
        "logical_txt": "2.0m",
        "num_value": 2.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": 2.0,
        "txt": "2.0m"
      },
      "mapper": "",
      "mappingMethod": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MAPPING_METHOD",
        "id": 390,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MAPPING_METHOD/",
        "logical_txt": "Digitoitu",
        "num_value": 4.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Digitoitu"
      },
      "owner": null,
      "plan": null,
      "remarks": "",
      "rentPaid": null,
      "renter": null,
      "scale": 1.0,
      "surveyAmount": "",
      "telecomArea": 10,
      "type": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MANHOLE_TYPE",
        "id": 1290,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MANHOLE_TYPE/",
        "logical_txt": "Profiilin muutoskohta",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Profiilin muutoskohta"
      },
      "updatedBy": "KEYCOM_STAGE",
      "updatedTs": "2010-07-22T10:53:47Z",
      "usageState": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MANHOLE_STATE",
        "id": 590,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MANHOLE_STATE/",
        "logical_txt": "Käytössä",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Käytössä"
      }
    },
    {
      "address": "https://example.keycom.fi/api/v2/apartments/7179/",
      "angle": 17.288388732063638,
      "createdBy": "",
      "createdTs": null,
      "diagramConfirm": null,
      "heightAccuracy": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "H_ACCURACY",
        "id": 117210,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/H_ACCURACY/",
        "logical_txt": "Ei määritelty",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Ei määritelty"
      },
      "historyDate": null,
      "id": 150,
      "identification": "",
      "installYear": null,
      "location": "SRID=3067;POINT Z (457712.6973 6703073.5746 0)",
      "locationAccuracy": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "LOCATION_ACCURACY",
        "id": 8301,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
        "logical_txt": "2.0m",
        "num_value": 2.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": 2.0,
        "txt": "2.0m"
      },
      "mapper": "",
      "mappingMethod": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MAPPING_METHOD",
        "id": 390,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MAPPING_METHOD/",
        "logical_txt": "Digitoitu",
        "num_value": 4.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Digitoitu"
      },
      "owner": null,
      "plan": null,
      "remarks": "",
      "rentPaid": null,
      "renter": null,
      "scale": 1.0,
      "surveyAmount": "",
      "telecomArea": 10,
      "type": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MANHOLE_TYPE",
        "id": 1290,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MANHOLE_TYPE/",
        "logical_txt": "Profiilin muutoskohta",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Profiilin muutoskohta"
      },
      "updatedBy": "KEYCOM_STAGE",
      "updatedTs": "2010-07-22T10:53:47Z",
      "usageState": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MANHOLE_STATE",
        "id": 590,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MANHOLE_STATE/",
        "logical_txt": "Käytössä",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Käytössä"
      }
    },
    {
      "address": "https://example.keycom.fi/api/v2/apartments/7179/",
      "angle": 90.0,
      "createdBy": "",
      "createdTs": null,
      "diagramConfirm": null,
      "heightAccuracy": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "H_ACCURACY",
        "id": 117210,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/H_ACCURACY/",
        "logical_txt": "Ei määritelty",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Ei määritelty"
      },
      "historyDate": null,
      "id": 190,
      "identification": "",
      "installYear": null,
      "location": null,
      "locationAccuracy": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "LOCATION_ACCURACY",
        "id": 8301,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
        "logical_txt": "2.0m",
        "num_value": 2.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": 2.0,
        "txt": "2.0m"
      },
      "mapper": "",
      "mappingMethod": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MAPPING_METHOD",
        "id": 390,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MAPPING_METHOD/",
        "logical_txt": "Digitoitu",
        "num_value": 4.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Digitoitu"
      },
      "owner": null,
      "plan": null,
      "remarks": "",
      "rentPaid": null,
      "renter": null,
      "scale": 1.0,
      "surveyAmount": "",
      "telecomArea": 10,
      "type": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MANHOLE_TYPE",
        "id": 1290,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MANHOLE_TYPE/",
        "logical_txt": "Profiilin muutoskohta",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Profiilin muutoskohta"
      },
      "updatedBy": "KEYCOM_STAGE",
      "updatedTs": "2010-07-22T10:48:09Z",
      "usageState": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MANHOLE_STATE",
        "id": 590,
        "list_url": "https://example.keycom.fi/api/v2/txt_constants/groupname/MANHOLE_STATE/",
        "logical_txt": "Käytössä",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Käytössä"
      }
    }
  ],
  "Total": 3509
}

Expand All

object

string (url)

Url to next page of manholes list. Null if No next page exist

string (url)

Url to previous page of manholes list. Null if No previous page exist

Results

Array of object (Manhole)

List of fetched manholes

object

information of a telecom manhole object

address

string (url)

url of manhole address apartments

angle

number (float)

Manhole's angle

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

diagramConfirm

object (DiagramConfirm)

For defining, if manhole diagram is confirmed

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

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants 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

height_accuracy

object (HeightAccuracy)

Height accuracy

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

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants 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

historyDate

string (date)

history date

integer

Manhole primary key

identification

string

Name of manhole. Checked based on Identification Uniqueness Rule

installYear

integer

Installation year

location

string (ewkt)

Geographical location. Available from product version 3.2.16.

locationAccuracy

object (LocationAccuracy)

Location accuracy

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

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants 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

mapper

string

mapper name

mappingMethod

object (MappingMethod)

Mapping method

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

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants 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

owner

object (ElManholeOwner)

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

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

string (url)

url of manhole plan

remarks

string

Remarks

rentPaid

boolean

Is rent paid or not

renter

object (ElManholeRenter)

Manhole renter

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

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

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

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants 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

surveyAmount

integer

unknown

telecomArea

object (TelecomArea)

Telecom Area

areaSize

number (float)

Area size

createdBy

string

Creator

createdTs

string (date-time)

Creation date time

exchangeArea

object (ExchangeArea)

Exchange Area

integer

Primary key

name

string

Area name

integer

Primary key

location

string (ewkt)

Geographical location

name

string

Area name

perimeter

number (float)

Area perimeter length

remarks

string

Area comments

telecomAreaType

object (TelecomAreaType)

Telecom area 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[ "TELECOM_AREA_TYPE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants 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

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

type

object (ManholeType)

Manhole 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[ "MANHOLE_TYPE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants 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

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usageState

object (ManholeUsageState)

Manhole usage state

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

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

Total

integer

Total number of telecom manholes

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

Get telecom manhole details