Get telecom manhole details

28 Oct 2024
5 Minutes to read
Contributors

Print
Dark
Light
PDF

Get telecom manhole details

Updated on 28 Oct 2024
5 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/manholes/{id}/

Operation is used to retrieve full details of given manhole id. Available from product version 3.2.8.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Path parameters

integerRequired

Id of manhole

Responses

200

Manhole

{
  "address": "https://example.keycom.fi/api/v2/apartments/1894/",
  "angle": 27.51,
  "createdBy": "user@keypro.fi",
  "createdTs": "2022-03-16T05:43:31Z",
  "diagramConfirm": null,
  "heightAccuracy": null,
  "historyDate": "2010-08-30",
  "id": 3484030,
  "identification": "Test manhole",
  "installYear": 2010,
  "location": "SRID=3067;POINT Z (462901.87226 6710903.57008 0)",
  "locationAccuracy": null,
  "mapper": "",
  "mappingMethod": null,
  "owner": null,
  "plan": null,
  "remarks": "Comment",
  "rentPaid": null,
  "renter": null,
  "scale": 1.0,
  "surveyAmount": "",
  "telecomArea": null,
  "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": "user@keypro.fi",
  "updatedTs": "2022-03-16T05:55:10Z",
  "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ä"
  }
}

Expand All

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

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Update telecom manhole partially