Get list of Telecom areas

28 Oct 2024
5 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of Telecom areas

Updated on 28 Oct 2024
5 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

The Get /telecom areas/ Operation retrieves a list of Telecom areas, available from product version 3.2.8. Users can filter results using HTTP query parameters, including an Authorization Token for security. Key parameters include offset (starting point for results) and limit (number of results returned), with a default limit applied if not specified. Filtering supports various object fields and structured queries, allowing for conditions like startswith, endswith, and numerical comparisons. Exclusive queries can be made using a not operator. The orderby parameter allows sorting of results by specified fields. Responses include a 200 status with a JSON object containing URLs for pagination and a list of Telecom areas, detailing attributes such as area size, creator, and availability. Errors are communicated with a 401 status for authentication issues. Overall, this operation facilitates efficient access and management of Telecom area data.

Did you find this summary helpful?

Thank you for your feedback

Get

/telecom-areas/

Operation is used to get a list of Telecom areas. Available from product version 3.2.8.

Telecom areas can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Query parameters

offset

integer

Offset to start returning results.

Minimum0

limit

integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Minimum1

__any of the object fields__

string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
For numerics: gt, lt, gte, lte, isnull
For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++

orderby

string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses

200

A result response object

{
  "Next": "https://example.keycom.fi/api/v2/telecom-areas/?limit=10&offset=10&orderby=-id",
  "Previous": null,
  "Results": [
    {
      "areaSize": 1044.59,
      "createdBy": "user",
      "createdTs": "2020-01-02T11:26:58Z",
      "exchangeArea": {
        "id": 5250,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "00000"
      },
      "id": 3323090,
      "location": "SRID=3067;POLYGON Z ((371969.1377000000211410 6845420.5158000001683831 0.0000000000000000, 372043.8693000000203028 6845430.8865000000223517 0.0000000000000000, 372000.4763099499978125 6845452.8206356000155210 0.0000000000000000, 371969.1377000000211410 6845420.5158000001683831 0.0000000000000000))",
      "name": "dwcxdwc",
      "perimeter": 169.08,
      "remarks": "",
      "telecomAreaType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TELECOM_AREA_TYPE",
        "id": 4535678,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
        "logical_txt": "MSM TYPE",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "MSM TYPE"
      },
      "updatedBy": "user",
      "updatedTs": "2020-01-02T11:27:45Z"
    },
    {
      "areaSize": 5123.58,
      "createdBy": "user",
      "createdTs": "2019-04-15T05:08:09Z",
      "exchangeArea": {
        "id": 18450,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "11"
      },
      "id": 2169430,
      "location": "SRID=3067;POLYGON Z ((422904.2042433799942955 6968625.7661052001640201 0.0000000000000000, 422888.5938351399963722 6968550.8890623003244400 0.0000000000000000, 422963.7354612299823202 6968527.3411584002897143 0.0000000000000000, 422949.9771353299729526 6968621.5327741997316480 0.0000000000000000, 422904.2042433799942955 6968625.7661052001640201 0.0000000000000000))",
      "name": "ABC",
      "perimeter": 296.39,
      "remarks": "",
      "telecomAreaType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TELECOM_AREA_TYPE",
        "id": 1111117,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
        "logical_txt": "aaaa",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "aaaa"
      },
      "updatedBy": "user",
      "updatedTs": "2019-04-15T05:08:09Z"
    },
    {
      "areaSize": 36682.23,
      "createdBy": "user",
      "createdTs": "2019-02-05T12:28:44Z",
      "exchangeArea": {
        "id": 12450,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "testi"
      },
      "id": 1869030,
      "location": "SRID=3067;POLYGON Z ((590532.3079673299798742 6785484.7543147001415491 0.0000000000000000, 590823.3494768299860880 6785548.2542804004624486 0.0000000000000000, 590812.7661492100451142 6785458.2959957001730800 0.0000000000000000, 590574.6412777999648824 6785310.1294090002775192 0.0000000000000000, 590532.3079673299798742 6785484.7543147001415491 0.0000000000000000))",
      "name": "test tasdasdasd",
      "perimeter": 848.61,
      "remarks": "",
      "telecomAreaType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TELECOM_AREA_TYPE",
        "id": 24652908,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
        "logical_txt": "AAAB",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "AAAB"
      },
      "updatedBy": "user",
      "updatedTs": "2019-02-05T12:28:44Z"
    },
    {
      "areaSize": 81890.99,
      "createdBy": "user",
      "createdTs": "2018-11-27T10:37:55Z",
      "exchangeArea": {
        "id": 2870,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "foobar"
      },
      "id": 1727830,
      "location": "SRID=3067;POLYGON Z ((463933.8995984499924816 6699072.4838843997567892 0.0000000000000000, 463908.7641953600104898 6699040.7339016003534198 0.0000000000000000, 463902.1496156000066549 6698979.8797677997499704 0.0000000000000000, 463937.8683463099878281 6698887.2756511000916362 0.0000000000000000, 463945.8058420200250112 6698874.0464915996417403 0.0000000000000000, 464033.1182948700152338 6698858.1715000998228788 0.0000000000000000, 464099.2640924900188111 6698851.5569203998893499 0.0000000000000000, 464121.7536636799923144 6698867.4319118000566959 0.0000000000000000, 464137.6286551000084728 6698961.3589444002136588 0.0000000000000000, 464161.4411422500270419 6698998.4005910996347666 0.0000000000000000, 464182.6077974800136872 6699016.9214144004508853 0.0000000000000000, 464199.8057048600167036 6699055.2859770003706217 0.0000000000000000, 464213.0348643800243735 6699112.1713629998266697 0.0000000000000000, 464219.6494441499817185 6699139.9525979999452829 0.0000000000000000, 464238.1702674800180830 6699192.8692361004650593 0.0000000000000000, 464006.6599758299998939 6699220.6504710996523499 0.0000000000000000, 463985.4933205900015309 6699191.5463201003149152 0.0000000000000000, 463982.8474886899930425 6699147.8900937000289559 0.0000000000000000, 463951.0975058299954981 6699098.9422035003080964 0.0000000000000000, 463998.7224801100092009 6699065.8693046998232603 0.0000000000000000, 463985.4933205900015309 6699049.9943132000043988 0.0000000000000000, 463933.8995984499924816 6699072.4838843997567892 0.0000000000000000))",
      "name": "TEST",
      "perimeter": 1257.79,
      "remarks": "",
      "telecomAreaType": null,
      "updatedBy": "user",
      "updatedTs": "2018-11-27T10:37:55Z"
    },
    {
      "areaSize": 959.33,
      "createdBy": "user",
      "createdTs": "2018-08-15T03:15:15Z",
      "exchangeArea": {
        "id": 5250,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "00000"
      },
      "id": 1248870,
      "location": "SRID=3067;POLYGON Z ((638326.8935000000055879 6946295.5102000003680587 0.0000000000000000, 638305.6029000000562519 6946324.4702000003308058 0.0000000000000000, 638343.7456036099465564 6946362.7056825999170542 0.0000000000000000, 638326.8935000000055879 6946295.5102000003680587 0.0000000000000000))",
      "name": "Noljakankaari Test2",
      "perimeter": 159.23,
      "remarks": "",
      "telecomAreaType": null,
      "updatedBy": "user",
      "updatedTs": "2018-08-15T03:15:15Z"
    },
    {
      "areaSize": 1258326.66,
      "createdBy": "user",
      "createdTs": "2018-05-29T02:28:41Z",
      "exchangeArea": {
        "id": 2090,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "Test"
      },
      "id": 905690,
      "location": "SRID=3067;POLYGON Z ((459067.4759319599834271 6706153.7079287003725767 0.0000000000000000, 459967.0587795099709183 6706550.5827144002541900 0.0000000000000000, 460760.8083508900017478 6705836.2081001996994019 0.0000000000000000, 459967.0587795099709183 6705254.1250812001526356 0.0000000000000000, 459305.6008033700054511 6705558.3957502003759146 0.0000000000000000, 459067.4759319599834271 6706153.7079287003725767 0.0000000000000000))",
      "name": "test",
      "perimeter": 4404.68,
      "remarks": "",
      "telecomAreaType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TELECOM_AREA_TYPE",
        "id": 4535678,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
        "logical_txt": "a",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "a"
      },
      "updatedBy": "user",
      "updatedTs": "2018-05-29T02:28:41Z"
    },
    {
      "areaSize": 284450.15,
      "createdBy": "user",
      "createdTs": "2017-05-17T10:46:01Z",
      "exchangeArea": {
        "id": 21650,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "testt"
      },
      "id": 40870,
      "location": "SRID=3067;POLYGON Z ((568944.6757999999681488 6882913.0307999998331070 0.0000000000000000, 569596.3466000000480562 6882878.1245999997481704 0.0000000000000000, 569596.8789000000106171 6882495.6913999998942018 0.0000000000000000, 568833.5993000000016764 6882494.6278999997302890 0.0000000000000000, 568944.6757999999681488 6882913.0307999998331070 0.0000000000000000))",
      "name": "1",
      "perimeter": 2232.11,
      "remarks": "1",
      "telecomAreaType": null,
      "updatedBy": "user",
      "updatedTs": "2017-05-17T10:46:01Z"
    },
    {
      "areaSize": 67405.39,
      "createdBy": "user",
      "createdTs": "2017-03-15T07:21:56Z",
      "exchangeArea": {
        "id": 21250,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "xtest"
      },
      "id": 40070,
      "location": "SRID=3067;POLYGON Z ((568688.5818999999901280 6882956.8223000001162291 0.0000000000000000, 568352.1676000000443310 6882961.8449999997392297 0.0000000000000000, 568357.1944000000366941 6882763.7520000003278255 0.0000000000000000, 568715.2957000000169501 6882766.9282999997958541 0.0000000000000000, 568688.5818999999901280 6882956.8223000001162291 0.0000000000000000))",
      "name": "1",
      "perimeter": 1084.92,
      "remarks": "",
      "telecomAreaType": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TELECOM_AREA_TYPE",
        "id": 7230982,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/TELECOM_AREA_TYPE/",
        "logical_txt": "BBBH",
        "num_value": null,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "BBBH"
      },
      "updatedBy": "user",
      "updatedTs": "2017-03-15T07:21:56Z"
    },
    {
      "areaSize": 170666.48,
      "createdBy": "user",
      "createdTs": "2017-03-13T07:19:50Z",
      "exchangeArea": {
        "id": 20850,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "ktest"
      },
      "id": 39670,
      "location": "SRID=3067;POLYGON Z ((568116.5389000000432134 6881887.1582000004127622 0.0000000000000000, 568557.1565999999875203 6881931.0646000001579523 0.0000000000000000, 568692.0428000000538304 6881580.3695000000298023 0.0000000000000000, 568079.5148000000044703 6881593.0598999997600913 0.0000000000000000, 568116.5389000000432134 6881887.1582000004127622 0.0000000000000000))",
      "name": "1",
      "perimeter": 1728.32,
      "remarks": "",
      "telecomAreaType": null,
      "updatedBy": "user",
      "updatedTs": "2017-03-13T07:19:50Z"
    },
    {
      "areaSize": 214432.02,
      "createdBy": "user",
      "createdTs": "2017-01-31T12:16:40Z",
      "exchangeArea": {
        "id": 20450,
        "listUrl": "https://example.keycom.fi/api/v2/exchange-areas/",
        "name": "testit1"
      },
      "id": 38870,
      "location": "SRID=3067;POLYGON Z ((506086.8348000000114553 7144981.2413999997079372 0.0000000000000000, 506072.0252999999793246 7144607.2713000001385808 0.0000000000000000, 506651.2273000000277534 7144598.2828999999910593 0.0000000000000000, 506639.0602000000071712 7144981.7740000002086163 0.0000000000000000, 506086.8348000000114553 7144981.2413999997079372 0.0000000000000000))",
      "name": "1",
      "perimeter": 1890.21,
      "remarks": "",
      "telecomAreaType": null,
      "updatedBy": "user",
      "updatedTs": "2017-01-31T12:16:40Z"
    }
  ],
  "Total": 114
}

Expand All

object

string (url)

Url to next page of Telecom areas data. Null if No next page exist

string (url)

Url to previous page of Telecom areas data. Null if No previous page exist

Results

Array of object (TelecomArea)

A list of fetched Telecom areas.

object

Telecom Area

areaSize

number (float)

Area size

createdBy

string

Creator

createdTs

string (date-time)

Creation date time

exchangeArea

object (ExchangeArea)

Exchange Area

integer

Primary key

name

string

Area name

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" ]

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

Total

integer

Total number of Telecom areas

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

Get Telecom Area details