Get Telecom Area details
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Get Telecom Area details

  • Dark
    Light
  • PDF

Article summary

Get
/telecom-areas/{id}

Operation is used to retrieve full details of given Telecom Area id. Available from product version 3.2.8.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of Telecom Area

Responses
200

Telecom Area

Expand All
object

Telecom Area

areaSize
number (float)

Area size

createdBy
string

Creator

createdTs
string (date-time)

Creation date time

exchangeArea
object (ExchangeArea)

Exchange Area

id
integer

Primary key

name
string

Area name

id
integer

Primary key

location
string (ewkt)

Geographical location

name
string

Area name

perimeter
number (float)

Area perimeter length

remarks
string

Area comments

telecomAreaType
object (TelecomAreaType)

Telecom area type

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "TELECOM_AREA_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

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?