Get list of Convert Codes

28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of Convert Codes

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

Get

/convert-codes/

Operation is used to get a list of Convert Codes. Available from product version 2024.3.

Convert Codes 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.

[
  {
    "code": "2110",
    "codeType": "",
    "description": "Cable route begins",
    "geometryType": {
      "groupName": "SURVEY_GEOM_TYPE",
      "id": 521,
      "listUrl": "http://10.121.8.9:8027/api/v2/geometry-types",
      "numValue": 2,
      "orderNo": 2,
      "txt": "Line",
      "txtValue": ""
    },
    "id": 1,
    "idText": "KARTOITETTU",
    "objectType": 1001,
    "operator": {
      "groupName": "SURVEY_DATA_OPERATOR",
      "id": 621,
      "listUrl": "http://10.121.8.9:8027/api/v2/operators",
      "numValue": 1,
      "orderNo": 1,
      "txt": "Sonera",
      "txtValue": ""
    },
    "specificType": 1001,
    "typeFieldId": "810"
  },
  {
    "code": "2111",
    "codeType": "",
    "description": "Cable route continues",
    "geometryType": {
      "groupName": "SURVEY_GEOM_TYPE",
      "id": 521,
      "listUrl": "https://keycore.example.fi/api/v2/geometry-types",
      "numValue": 2,
      "orderNo": 2,
      "txt": "Line",
      "txtValue": ""
    },
    "id": 21,
    "idText": "KARTOITETTU",
    "objectType": 1011,
    "operator": {
      "groupName": "SURVEY_DATA_OPERATOR",
      "id": 621,
      "listUrl": "https://keycore.example.fi/api/v2/operators",
      "numValue": 1,
      "orderNo": 1,
      "txt": "Sonera",
      "txtValue": ""
    },
    "specificType": 1002,
    "typeFieldId": "810"
  }
]

Expand All

object

string (url)

Url to next page of Convert Codes list. Null if No next page exist

string (url)

Url to previous page of Convert Codes list. Null if No previous page exist

Results

Array of object (ConvertCode)

List of fetched Convert Codes

object

code

string

Convert code string

codeType

string

Convert code type

description

string

Convert code description

geometryType

object (GeometryType)

Geometry Type

groupname

Group name of constant

Valid values[ "SURVEY_GEOM_TYPE" ]

integer

Unique id of constant

listUrl

string (url)

Url to fetch all contants from this group

numValue

integer

Numeric value

orderno

integer

Order number

txt

string

Human readable textual representation

txtValue

string

Text value

integer

Primary key

idText

integer

Convert code text

objectType

integer

Convert code object type

operator

object (Operator)

Operator

groupname

Group name of constant

Valid values[ "SURVEY_DATA_OPERATOR" ]

integer

Unique id of constant

listUrl

string (url)

Url to fetch all contants from this group

numValue

integer

Numeric value

orderno

integer

Order number

txt

string

Human readable textual representation

txtValue

string

Text value

specificType

integer

Convert code specific type

typeFieldId

integer

Convert code type id

Total

integer

Total number of Convert Codes in the list

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 list of cross connection point types