Create new premises

28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Create new premises

Updated on 28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/premises/

Operation is used to create new premises. Available from product version 3.0.24.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

premises to be created

object

Manhole

integer

Manhole id

Pole

integer

Pole id

address

integer

Address id

angle

number (float)

Premises' angle

capacity

integer

Capacity

deviceRoom

integer

Device room id

diagramConfirm

integer

Diagram confirmed id

heightAccuracy

integer

Height Accuracy id

historyDate

string (date-time)

Mapping date

identification

string

Premises identification. Checked based on Identification Uniqueness Rule

importance

integer

Importance id

install_year

integer

Install year

location

string (ewkt)

Geographical location

locationAccuracy

integer

Location accuracy id

mapper

string

Mapper

mappingMethod

integer

Mapping method id

name

string

Name of the premises

owner

integer

Owner id

plan

integer

Plan id

remarks

string

Premises' remarks

renter

integer

Renter id

safetyDistance

integer

Safety distance id. Available from product version 3.6.4.

scale

number (float)

Scale

sourceSystem

integer

Available from product version 3.4.

sourceSystemKey

integer

Source system key. Available from product version 3.4.

survey_amount

string

Survey amount

technicalId

integer

Technical id

technicalInfo

string

Technical information

telecomArea

integer

Telecom area id

type

integer Required

Premises type id

usageState

integer Required

Usage state id

Responses

201

A created Premises

{
  "address": 1894,
  "angle": 99.18,
  "capacity": 30,
  "createdBy": "user@keypro.fi",
  "createdTs": "2019-11-27T01:36:31Z",
  "deviceRoom": 5401,
  "diagramConfirm": null,
  "heightAccuracy": 117210,
  "historyDate": "2010-08-30T01:29:57Z",
  "id": 3295770,
  "identification": "Test premises",
  "importance": null,
  "install_year": 1999,
  "location": "POINT Z (456966.0724000000045635 6700798.3214999996125698 0.0000000000000000)",
  "locationAccuracy": 8301,
  "mapper": "",
  "mappingMethod": 390,
  "name": "Test premise",
  "owner": 2010,
  "plan": null,
  "remarks": "Comment",
  "renter": null,
  "scale": 1.0,
  "survey_amount": "",
  "telecomArea": null,
  "type": 801,
  "updatedBy": "user@keypro.fi",
  "updatedTs": "2019-11-27T01:36:31Z",
  "usageState": 14601
}

object

Manhole

integer

Manhole id

Pole

integer

Pole id

address

integer

Address id

angle

number (float)

Premises' angle

capacity

integer

Capacity

createdBy

string

Creator

createdTs

string (date-time)

Creation date time

deviceRoom

integer

Device room id

diagramConfirm

integer

Diagram confirmed id

heightAccuracy

integer

Height Accuracy id

historyDate

string (date-time)

Mapping date

integer

Primary key

identification

string

Premises identification. Checked based on Identification Uniqueness Rule

importance

integer

Importance id

install_year

integer

Install year

location

string (ewkt)

Geographical location

locationAccuracy

integer

Location accuracy id

mapper

string

Mapper

mappingMethod

integer

Mapping method id

name

string

Name of the premises

owner

integer

Owner id

plan

integer

Plan id

remarks

string

Premises' remarks

renter

integer

Renter id

safetyDistance

integer

Safety distance id. Available from product version 3.6.4.

scale

number (float)

Scale

sourceSystem

integer

Available from product version 3.4.

sourceSystemKey

integer

Source system key. Available from product version 3.4.

survey_amount

string

Survey amount

technicalId

integer

Technical id

technicalInfo

string

Technical information

telecomArea

integer

Telecom area id

type

integer

Premises type id

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.

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

Delete premises