Create new Telecom Area
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new Telecom Area

  • Dark
    Light
  • PDF

Article summary

Post
/telecom-areas/

Operation is used to create new telecom area. Available from product version 3.2.8.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Telecom Area to be created

object

Telecom Area

areaSize
number (float)

Area size

exchangeArea
integer Required

related Exchange Area id

id
integer

Primary key

location
string (ewkt)

Geographical location

name
string Required

Area name

perimeter
number (float)

Area perimeter length

remarks
string

Area comments

telecomAreaType
integer

Telecom Area id

Responses
201

created Telecom Area data

{
  "areaSize": null,
  "createdBy": "user",
  "createdTs": "2020-05-24T11:48:02Z",
  "exchangeArea": 4358950,
  "id": 4402290,
  "location": "SRID=3067;POLYGON Z ((454481.3499999999767169 6702875.8399999998509884 0.0000000000000000, 454490.0800000000162981 6702865.0060000000521541 0.0000000000000000, 454482.6799999999930151 6702860.7699999995529652 0.0000000000000000, 454474.3499999999767169 6702862.2199999997392297 0.0000000000000000, 454469.8499999999767169 6702870.8200000002980232 0.0000000000000000, 454472.7600000000093132 6702875.3200000002980232 0.0000000000000000, 454481.3499999999767169 6702875.8399999998509884 0.0000000000000000))",
  "name": "test-area-automated",
  "perimeter": null,
  "remarks": "",
  "telecomAreaType": 1258824,
  "updatedBy": "user",
  "updatedTs": "2020-05-24T11:48:02Z"
}
object

Telecom Area

areaSize
number (float)

Area size

createdBy
string

Creator

createdTs
string (date-time)

Creation date time

exchangeArea
integer

related Exchange Area id

id
integer

Primary key

location
string (ewkt)

Geographical location

name
string

Area name

perimeter
number (float)

Area perimeter length

remarks
string

Area comments

telecomAreaType
integer

Telecom Area id

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

400

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

{
  "exchangeArea": [
    "This field is required."
  ],
  "name": [
    "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?