Create new pole

28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Create new pole

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

/poles/

Operation is used to create new pole. Available from product version 3.2.24.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Pole to be created

object

angle

number (float)

Angle

branch_pole_number

string

Branch Pole

checkout_date

string (date)

Checkout Date

decay_class

integer

Id of decay class

height_accuracy

integer

Id of height accuracy

history_date

string (date)

Checkout Date

impregnant

integer

Id of impregnant

install_year

integer

Install year

length

number (float)

Pole length

line_part

string

Line Part

location

string (ewkt)

Location of pole in EWKT

location_accuracy

integer

Id of location accuracy

mapper

string

Mapper

mapping_method

integer

Id of mapping method

material

integer

Id of material

owner

integer

Id of owner

plan

integer

Id of plan

pole_number

string

Pole number

pole_type

integer Required

Id of pole type

remarks

string

Remarks. Available from product version 3.2.14.

renter

integer

Id of renter

scale

number (float)

Scale

stanchion

integer

Id of stanchion

stanchion_decay_class

integer

Id of stanchion decay class

survey_amount

string

Survey amount

telecom_area

integer

Id of telecom area

usage_state

integer Required

Id of state

Responses

201

A created pole

{
  "angle": null,
  "branch_pole_number": "",
  "checkout_date": null,
  "created_by": "redenfloyd.cayanan",
  "created_ts": "2022-04-04T09:34:03Z",
  "decay_class": null,
  "height_accuracy": null,
  "history_date": null,
  "id": 1230650,
  "impregnant": null,
  "install_year": null,
  "length": null,
  "line_part": "",
  "location": null,
  "location_accuracy": null,
  "mapper": "",
  "mapping_method": null,
  "material": null,
  "owner": null,
  "plan": null,
  "pole_number": "",
  "pole_type": 1621,
  "remarks": "",
  "renter": null,
  "scale": null,
  "stanchion": null,
  "station_decay_class": null,
  "survey_amount": "",
  "telecom_area": null,
  "updated_by": "redenfloyd.cayanan",
  "updated_ts": "2022-04-04T09:34:03Z",
  "usage_state": 770
}

object

angle

number (float)

Angle

branch_pole_number

string

Branch Pole

checkout_date

string (date)

Checkout Date

created_by

string

Created by

created_ts

string (date-time)

Created timestamp

decay_class

integer

Id of decay class

height_accuracy

integer

Id of height accuracy

history_date

string (date)

Checkout Date

integer

Primary key

impregnant

integer

Id of impregnant

install_year

integer

Install year

length

number (float)

Pole length

line_part

string

Line Part

location

string (ewkt)

Location of pole in EWKT

location_accuracy

integer

Id of location accuracy

mapper

string

Mapper

mapping_method

integer

Id of mapping method

material

integer

Id of material

owner

integer

Id of owner

plan

integer

Id of plan

pole_number

string

Pole number

pole_type

integer

Id of pole type

remarks

string

Remarks. Available from product version 3.2.14.

renter

integer

Id of renter

scale

number (float)

Scale

stanchion

integer

Id of stanchion

stanchion_decay_class

integer

Id of stanchion decay class

survey_amount

string

Survey amount

telecom_area

integer

Id of telecom area

updated_by

string

Last updated by

updated_ts

string (date-time)

Last updated timestamp

usage_state

integer

Id of state

400

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

{
  "pole_type": [
    "This field is required."
  ],
  "usage_state": [
    "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

Delete pole