Create new telecom manhole
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new telecom manhole

  • Dark
    Light
  • PDF

Article summary

Post
/manholes/

Operation is used to create new telecom manhole. Available from product version 3.2.22.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Manhole to be created.

object

information of a telecom manhole object

address
integer

id of manhole address apartments

angle
number (float)

Manhole's angle

diagramConfirm
integer

Diagram confirmed id

heightAccuracy
integer

Height Accuracy id

historyDate
string (date)

history date

identification
string Required

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.

location_accuracy
integer

Location accuracy id

mapper
string

mapper name

mappingMethod
integer

Mapping method id

owner
integer

Owner id

plan
integer

id of manhole plan

remarks
string

Remarks

rentPaid
boolean

Is rent paid or not

renter
integer

Renter id

safetyDistance
integer

Safety distance id. Available from product version 3.6.4.

scale
number (float)

Scale

surveyAmount
integer

unknown

telecomArea
integer

Telecom area id

type
integer Required

id of Manhole type

usageState
integer Required

Usage state id

Responses
201

A created Manhole

{
  "address": 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": 1290,
  "updatedBy": "user@keypro.fi",
  "updatedTs": "2022-03-16T05:43:31Z",
  "usageState": 590
}
object

information of a telecom manhole object

address
integer

id of manhole address apartments

angle
number (float)

Manhole's angle

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

diagramConfirm
integer

Diagram confirmed id

heightAccuracy
integer

Height Accuracy id

historyDate
string (date)

history date

id
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.

location_accuracy
integer

Location accuracy id

mapper
string

mapper name

mappingMethod
integer

Mapping method id

owner
integer

Owner id

plan
integer

id of manhole plan

remarks
string

Remarks

rentPaid
boolean

Is rent paid or not

renter
integer

Renter id

safetyDistance
integer

Safety distance id. Available from product version 3.6.4.

scale
number (float)

Scale

surveyAmount
integer

unknown

telecomArea
integer

Telecom area id

type
integer

id of Manhole type

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

usageState
integer

Usage state id

400

There was an error in request. Usually field validation failed.

{
  "state": [
    "This field is required."
  ],
  "type": [
    "This field is required."
  ]
}
object

Fields which failed validation

property*
Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

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