Update premises partially
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update premises partially

  • Dark
    Light
  • PDF

Article summary

Patch
/premises/{id}/

Operation is used to update specific fields in existing premises. Available from product version 3.0.24.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of premises to update

Body parameters

Premises attributes and values to be updated

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
200

Object was updated successfully

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

id
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

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?