Get list of Survey Line Strings

28 Aug 2024
19 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of Survey Line Strings

Updated on 28 Aug 2024
19 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/survey-lines/

Operation is used to get a list of Survey Line Strings. Available from product version 2024.3.

Survey Line Strings 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

srs

string

Coordinate system to transform location to.

Example: srs=epsg:4326

Responses

200

A result response object

{
  "Next": "http://testserver/api/v2/survey-line-strings/?limit=10&offset=10",
  "Previous": null,
  "Results": [
    {
      "code": "2111",
      "convertCode": {
        "code": "2110",
        "codeType": "",
        "description": "Cable route begins",
        "geometryType": {
          "groupname": "SURVEY_GEOM_TYPE",
          "id": 521,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_GEOM_TYPE/",
          "numValue": 2,
          "orderno": 2,
          "txt": "Line",
          "txtValue": ""
        },
        "id": 1,
        "idText": "KARTOITETTU",
        "listUrl": "http://keycore.example.fi/api/v2/convert-codes",
        "objectType": 1001,
        "operator": {
          "groupname": "SURVEY_DATA_OPERATOR",
          "id": 621,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
          "numValue": 1,
          "orderno": 1,
          "txt": "Sonera",
          "txtValue": ""
        },
        "specificType": 1001,
        "typeFieldId": "810"
      },
      "id": 23781,
      "length": 1411.79,
      "location": "SRID=3067;LINESTRING Z (440108.2345358517 6718072.808745892 0, 442225.1571307772 6717897.495076658 0, 444347.0799328478 6717739.062695649 0)",
      "operator": {
        "groupname": "SURVEY_DATA_OPERATOR",
        "id": 621,
        "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
        "numValue": 1,
        "orderno": 1,
        "txt": "Sonera",
        "txtValue": ""
      },
      "surveyFile": {
        "combinePoint": true,
        "combinePointNumber": true,
        "coordinateOrder": null,
        "createdBy": "test.user",
        "createdDate": "2016-09-01T12:17:34Z",
        "fileName": "testi_01092016.txt",
        "hashCode": "f4dc74cd67464caef81a467f8a49cce8b4680415",
        "heightAccuracy": null,
        "historyDate": null,
        "id": 5721,
        "identification": "testi_01092016.txt",
        "inputSrs": "EPSG:3067",
        "kindCode": null,
        "listUrl": "http://keycore.example.fi/api/v2/survey-files/",
        "locationAccuracy": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "LOCATION_ACCURACY",
          "id": 7981,
          "list_url": "http://keycore.example.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
          "logical_txt": "1.0m",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": 3.0,
          "txt": "1.0m"
        },
        "mapper": "test.user",
        "mappingConfig": {
          "id": 1,
          "label": "T3 PIH",
          "listUrl": "http://keycore.example.fi/api/v2/mapping-configs",
          "separator": ""
        },
        "mappingMethod": null,
        "name": "",
        "operator": {
          "groupname": "SURVEY_DATA_OPERATOR",
          "id": 621,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
          "numValue": 1,
          "orderno": 1,
          "txt": "Sonera",
          "txtValue": ""
        },
        "procedure": {
          "groupname": "PROCEDURE",
          "id": 101,
          "listUrl": "https://keycore.example.fi/api/v2/survey-constants/groupname/PROCEDURE/",
          "numValue": 2,
          "orderno": 2,
          "txt": "Create geometries",
          "txtValue": ""
        },
        "processed": false,
        "rawText": "9\t1\t2111\t1\t7241180.18549\t3483344.50444\t115.098\n9\t1\t2111",
        "srid": 294914,
        "surveyAmount": null,
        "updatedBy": "test.user",
        "updatedDate": "2016-09-01T12:17:34Z"
      },
      "updatedBy": "test.user",
      "updatedTs": "2021-04-22T12:30:15Z",
      "zCoord": "123.552"
    },
    {
      "code": "2111",
      "convertCode": null,
      "id": 23801,
      "length": 20350.71,
      "location": "SRID=3067;LINESTRING Z (478008.7406 7239477.5365 0, 478003.4746 7239486.4885 0, 477995.4586 7239499.9436 0)",
      "operator": null,
      "surveyFile": {
        "combinePoint": true,
        "combinePointNumber": true,
        "coordinateOrder": null,
        "createdBy": "test.user",
        "createdDate": "2016-09-01T12:17:34Z",
        "fileName": "testi_01092016.txt",
        "hashCode": "f4dc74cd67464caef81a467f8a49cce8b4680415",
        "heightAccuracy": null,
        "historyDate": null,
        "id": 5721,
        "identification": "testi_01092016.txt",
        "inputSrs": "EPSG:3067",
        "kindCode": null,
        "listUrl": "http://keycore.example.fi/api/v2/survey-files/",
        "locationAccuracy": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "LOCATION_ACCURACY",
          "id": 7981,
          "list_url": "http://keycore.example.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
          "logical_txt": "1.0m",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": 3.0,
          "txt": "1.0m"
        },
        "mapper": "test.user",
        "mappingConfig": {
          "id": 1,
          "label": "T3 PIH",
          "listUrl": "http://keycore.example.fi/api/v2/mapping-configs",
          "separator": ""
        },
        "mappingMethod": null,
        "name": "",
        "operator": {
          "groupname": "SURVEY_DATA_OPERATOR",
          "id": 621,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
          "numValue": 1,
          "orderno": 1,
          "txt": "Sonera",
          "txtValue": ""
        },
        "procedure": {
          "groupname": "PROCEDURE",
          "id": 101,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/PROCEDURE/",
          "numValue": 2,
          "orderno": 2,
          "txt": "Create geometries",
          "txtValue": ""
        },
        "processed": false,
        "rawText": "9\t1\t2111\t1\t7241180.18549\t3483344.50444\t115.098\n9\t1\t2111\t2\t7241179.31911\t3483354.96564\t114.849\n9\t1\t2111\t3\t7241178.1556\t3483370.5469\t114.031\n9\t1\t2111\t4\t7241178.70476\t3483392.56676\t113.465\n9\t1\t2111\t5\t7241177.85634\t3483416.43835\t112.843\n9\t1\t2111\t6\t7241177.14301\t3483433.84035\t112.512\n9\t1\t2111\t7\t7241176.2636\t3483450.17791\t111.779\n9\t1\t2111\t8\t7241174.20174\t3483461.63051\t112.178\n9\t1\t2111\t9\t7241173.83156\t3483472.18376\t110.835\n9\t1\t2111\t10\t7241172.86809\t3483501.31747\t109.474\n9\t1\t2111\t11\t7241172.40883\t3483526.7677\t108.875\n9\t1\t2111\t12\t7241170.46291\t3483573.20637\t108.525\n9\t1\t2111\t13\t7241169.53247\t3483597.19601\t108.494\n9",
        "srid": 294914,
        "surveyAmount": null,
        "updatedBy": "test.user",
        "updatedDate": "2016-09-01T12:17:34Z"
      },
      "updatedBy": "test.user",
      "updatedTs": "2016-09-01T12:17:48Z",
      "zCoord": "105.838"
    },
    {
      "code": "2111",
      "convertCode": null,
      "id": 23821,
      "length": 5619.92,
      "location": "SRID=3067;LINESTRING Z (480324.5819 7285492.5469 0, 480325.9509 7285500.9989 0, 480325.9209 7285502.5379 0)",
      "operator": null,
      "surveyFile": {
        "combinePoint": true,
        "combinePointNumber": true,
        "coordinateOrder": null,
        "createdBy": "test.user",
        "createdDate": "2016-09-01T12:17:34Z",
        "fileName": "testi_01092016.txt",
        "hashCode": "f4dc74cd67464caef81a467f8a49cce8b4680415",
        "heightAccuracy": null,
        "historyDate": null,
        "id": 5721,
        "identification": "testi_01092016.txt",
        "inputSrs": "EPSG:3067",
        "kindCode": null,
        "listUrl": "http://keycore.example.fi/api/v2/survey-files/",
        "locationAccuracy": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "LOCATION_ACCURACY",
          "id": 7981,
          "list_url": "http://keycore.example.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
          "logical_txt": "1.0m",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": 3.0,
          "txt": "1.0m"
        },
        "mapper": "test.user",
        "mappingConfig": {
          "id": 1,
          "label": "T3 PIH",
          "listUrl": "http://keycore.example.fi/api/v2/mapping-configs",
          "separator": ""
        },
        "mappingMethod": null,
        "name": "",
        "operator": {
          "groupname": "SURVEY_DATA_OPERATOR",
          "id": 621,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
          "numValue": 1,
          "orderno": 1,
          "txt": "Sonera",
          "txtValue": ""
        },
        "procedure": {
          "groupname": "PROCEDURE",
          "id": 101,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/PROCEDURE/",
          "numValue": 2,
          "orderno": 2,
          "txt": "Create geometries",
          "txtValue": ""
        },
        "processed": false,
        "rawText": "9\t1\t2111\t1\t7241180.18549\t3483344.50444\t115.098\n9\t1\t2111\t2\t7241179.31911\t3483354.96564\t114.849\n9\t1\t2111\t3\t7241178.1556\t3483370.5469\t114",
        "srid": 294914,
        "surveyAmount": null,
        "updatedBy": "test.user",
        "updatedDate": "2016-09-01T12:17:34Z"
      },
      "updatedBy": "test.user",
      "updatedTs": "2016-09-01T12:17:49Z",
      "zCoord": "138.518"
    },
    {
      "code": "2111",
      "convertCode": null,
      "id": 23841,
      "length": 10820.73,
      "location": "SRID=3067;LINESTRING Z (482030.7616 7275385.4065 0, 482032.2226 7275389.7205 0, 482032.8776 7275396.9615 0)",
      "operator": null,
      "surveyFile": {
        "combinePoint": true,
        "combinePointNumber": true,
        "coordinateOrder": null,
        "createdBy": "test.user",
        "createdDate": "2016-09-01T12:17:34Z",
        "fileName": "testi_01092016.txt",
        "hashCode": "f4dc74cd67464caef81a467f8a49cce8b4680415",
        "heightAccuracy": null,
        "historyDate": null,
        "id": 5721,
        "identification": "testi_01092016.txt",
        "inputSrs": "EPSG:3067",
        "kindCode": null,
        "listUrl": "http://keycore.example.fi/api/v2/survey-files/",
        "locationAccuracy": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "LOCATION_ACCURACY",
          "id": 7981,
          "list_url": "http://keycore.example.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
          "logical_txt": "1.0m",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": 3.0,
          "txt": "1.0m"
        },
        "mapper": "test.user",
        "mappingConfig": {
          "id": 1,
          "label": "T3 PIH",
          "listUrl": "http://keycore.example.fi/api/v2/mapping-configs",
          "separator": ""
        },
        "mappingMethod": null,
        "name": "",
        "operator": {
          "groupname": "SURVEY_DATA_OPERATOR",
          "id": 621,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
          "numValue": 1,
          "orderno": 1,
          "txt": "Sonera",
          "txtValue": ""
        },
        "procedure": {
          "groupname": "PROCEDURE",
          "id": 101,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/PROCEDURE/",
          "numValue": 2,
          "orderno": 2,
          "txt": "Create geometries",
          "txtValue": ""
        },
        "processed": false,
        "rawText": "9\t1\t2111\t1\t7241180.18549\t3483344.50444\t115.098\n9\t1\t2111\t2\t7241179.31911\t3483354.96564\t114.849\n9",
        "srid": 294914,
        "surveyAmount": null,
        "updatedBy": "test.user",
        "updatedDate": "2016-09-01T12:17:34Z"
      },
      "updatedBy": "test.user",
      "updatedTs": "2016-09-01T12:17:51Z",
      "zCoord": "117.962"
    },
    {
      "code": "2111",
      "convertCode": null,
      "id": 23861,
      "length": 5147.08,
      "location": "SRID=3067;LINESTRING Z (474718.9567 7237189.0361 0, 474723.9297 7237186.633 0, 474741.3357 7237176.491 0)",
      "operator": null,
      "surveyFile": {
        "combinePoint": true,
        "combinePointNumber": true,
        "coordinateOrder": null,
        "createdBy": "test.user",
        "createdDate": "2016-09-01T12:17:34Z",
        "fileName": "testi_01092016.txt",
        "hashCode": "f4dc74cd67464caef81a467f8a49cce8b4680415",
        "heightAccuracy": null,
        "historyDate": null,
        "id": 5721,
        "identification": "testi_01092016.txt",
        "inputSrs": "EPSG:3067",
        "kindCode": null,
        "listUrl": "http://keycore.example.fi/api/v2/survey-files/",
        "locationAccuracy": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "LOCATION_ACCURACY",
          "id": 7981,
          "list_url": "http://keycore.example.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
          "logical_txt": "1.0m",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": 3.0,
          "txt": "1.0m"
        },
        "mapper": "test.user",
        "mappingConfig": {
          "id": 1,
          "label": "T3 PIH",
          "listUrl": "http://keycore.example.fi/api/v2/mapping-configs",
          "separator": ""
        },
        "mappingMethod": null,
        "name": "",
        "operator": {
          "groupname": "SURVEY_DATA_OPERATOR",
          "id": 621,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
          "numValue": 1,
          "orderno": 1,
          "txt": "Sonera",
          "txtValue": ""
        },
        "procedure": {
          "groupname": "PROCEDURE",
          "id": 101,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/PROCEDURE/",
          "numValue": 2,
          "orderno": 2,
          "txt": "Create geometries",
          "txtValue": ""
        },
        "processed": false,
        "rawText": "9\t1\t2111\t1\t7241180.18549\t3483344.50444\t115.098\n9\t1\t2111",
        "srid": 294914,
        "surveyAmount": null,
        "updatedBy": "test.user",
        "updatedDate": "2016-09-01T12:17:34Z"
      },
      "updatedBy": "test.user",
      "updatedTs": "2018-04-25T11:01:40Z",
      "zCoord": "115.584"
    },
    {
      "code": "2111",
      "convertCode": null,
      "id": 23881,
      "length": 8669.7,
      "location": "SRID=3067;LINESTRING Z (463660.287 7266942.2046 0, 463666.63 7266943.0366 0, 463676.658 7266943.6456 0)",
      "operator": null,
      "surveyFile": {
        "combinePoint": true,
        "combinePointNumber": true,
        "coordinateOrder": null,
        "createdBy": "test.user",
        "createdDate": "2016-09-01T12:17:34Z",
        "fileName": "testi_01092016.txt",
        "hashCode": "f4dc74cd67464caef81a467f8a49cce8b4680415",
        "heightAccuracy": null,
        "historyDate": null,
        "id": 5721,
        "identification": "testi_01092016.txt",
        "inputSrs": "EPSG:3067",
        "kindCode": null,
        "listUrl": "http://keycore.example.fi/api/v2/survey-files/",
        "locationAccuracy": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "LOCATION_ACCURACY",
          "id": 7981,
          "list_url": "http://keycore.example.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
          "logical_txt": "1.0m",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": 3.0,
          "txt": "1.0m"
        },
        "mapper": "test.user",
        "mappingConfig": {
          "id": 1,
          "label": "T3 PIH",
          "listUrl": "http://keycore.example.fi/api/v2/mapping-configs",
          "separator": ""
        },
        "mappingMethod": null,
        "name": "",
        "operator": {
          "groupname": "SURVEY_DATA_OPERATOR",
          "id": 621,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
          "numValue": 1,
          "orderno": 1,
          "txt": "Sonera",
          "txtValue": ""
        },
        "procedure": {
          "groupname": "PROCEDURE",
          "id": 101,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/PROCEDURE/",
          "numValue": 2,
          "orderno": 2,
          "txt": "Create geometries",
          "txtValue": ""
        },
        "processed": false,
        "rawText": "9\t1\t2111\t1\t7241180.18549\t3483344.50444\t115.098\n9\t1\t2111\t2\t7241179.31911",
        "srid": 294914,
        "surveyAmount": null,
        "updatedBy": "test.user",
        "updatedDate": "2016-09-01T12:17:34Z"
      },
      "updatedBy": "test.user",
      "updatedTs": "2016-09-01T12:18:33Z",
      "zCoord": "91.719"
    },
    {
      "code": "2111",
      "convertCode": null,
      "id": 23901,
      "length": 357.09,
      "location": "SRID=3067;LINESTRING Z (469709.5092 7264759.3009 0, 469707.2661 7264749.5099 0, 469706.9891 7264747.1489 0)",
      "operator": null,
      "surveyFile": {
        "combinePoint": true,
        "combinePointNumber": true,
        "coordinateOrder": null,
        "createdBy": "test.user",
        "createdDate": "2016-09-01T12:17:34Z",
        "fileName": "testi_01092016.txt",
        "hashCode": "f4dc74cd67464caef81a467f8a49cce8b4680415",
        "heightAccuracy": null,
        "historyDate": null,
        "id": 5721,
        "identification": "testi_01092016.txt",
        "inputSrs": "EPSG:3067",
        "kindCode": null,
        "listUrl": "http://keycore.example.fi/api/v2/survey-files/",
        "locationAccuracy": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "LOCATION_ACCURACY",
          "id": 7981,
          "list_url": "http://keycore.example.fi/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
          "logical_txt": "1.0m",
          "num_value": 1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": 3.0,
          "txt": "1.0m"
        },
        "mapper": "test.user",
        "mappingConfig": {
          "id": 1,
          "label": "T3 PIH",
          "listUrl": "http://keycore.example.fi/api/v2/mapping-configs",
          "separator": ""
        },
        "mappingMethod": null,
        "name": "",
        "operator": {
          "groupname": "SURVEY_DATA_OPERATOR",
          "id": 621,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR/",
          "numValue": 1,
          "orderno": 1,
          "txt": "Sonera",
          "txtValue": ""
        },
        "procedure": {
          "groupname": "PROCEDURE",
          "id": 101,
          "listUrl": "http://keycore.example.fi/api/v2/survey-constants/groupname/PROCEDURE/",
          "numValue": 2,
          "orderno": 2,
          "txt": "Create geometries",
          "txtValue": ""
        },
        "processed": false,
        "rawText": "9\t1\t2111\t1\t7241180.18549\t3483344.50444\t115.877",
        "srid": 294914,
        "surveyAmount": null,
        "updatedBy": "test.user",
        "updatedDate": "2016-09-01T12:17:34Z"
      },
      "updatedBy": "test.user",
      "updatedTs": "2016-09-01T12:19:05Z",
      "zCoord": "107.472"
    }
  ],
  "Total": 505
}

Expand All

object

string (url)

URL to next page of Survey Line Strings list. Null if No next page exist

string (url)

URL to previous page of Survey Line Strings list. Null if No previous page exist

Results

Array of object (SurveyLineString)

List of Survey Line Strings

object

Survey Line String

code

string

Code

convertCode

object (ConvertCode)

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

integer

Unique identifier of survey line string

length

number (float)

Length of the survey line string

location

string (ewkt)

Geographical location

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

surveyFile

object (SurveyFile)

SurveyFile

combinePoint

boolean

Is survey file processed to have combined point

combinePointNumber

boolean

Is survey file processed to have combined point number

coordinateOrder

object (CoordinateOrder)

Coordinate Order

groupname

Group name of constant

Valid values[ "COORDINATE_ORDER" ]

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

createdBy

string

created by user

createdDate

string (date-time)

created date

fileName

string

file name attached to the survey file

hashCode

string

hash code of the file attached to the survey file

heightAccuracy

object (HeightAccuracy)

Height accuracy

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

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

historyDate

string (date)

history date of survey file

integer

Unique id of survey file

identification

string

identification of survey file

inputSrs

string

input srs of the survey file

kindCode

object (KindCode)

Kind Code

groupname

Group name of constant

Valid values[ "KIND_CODE" ]

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

locationAccuracy

object (LocationAccuracy)

Location accuracy

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

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

mapper

string

Mapper of the survey file

mappingConfig

object (MappingConfig)

integer

Primary key

label

string

Mapping config label

separator

string

Mapping config separator

mappingMethod

object (MappingMethod)

Mapping method

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

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

name

string

name of survey file

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

plan

object (Plan)

Plan

Branch_line

object (DHCPDN)

District Heating Consumer Point Duct Diameter

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

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

Center_measure

object (DHCPDN)

District Heating Consumer Point Duct Diameter

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

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

Construction

object (PlanConstruction)

Plan Construction

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

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

Excavation

object (PlanExcavation)

Plan Excavation

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

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

Limiter

object (DHCPLimiter)

District Heating Consumer Point Limiter

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

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

Plan_piping

object (PlanPiping)

Plan Piping

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

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

agreed_delivery_date

string (date-time)

Agreed Delivery Date. Activated on request by customer.

area_description

string

Area Description. Activated on request by customer.

begin_date

string (date-time)

Begin Date

construction_year

integer

Contact Name. Not shown when displaying plan details in related objects. Activated on request by customer.

contact_email

string

Contact Email Address. Activated on request by customer.

contact_name

string

Contact Name. Activated on request by customer.

contact_phone

string

Contact phone number. Activated on request by customer.

cp_identification

string

Consumer Point Identification. Activated on request by customer.

created_by

string

Created by

created_date

string (date-time)

Create Date

customer_contact_date

string (date-time)

Customer Contact Date. Activated on request by customer.

description

string

Description

desired_delivery_date

string (date-time)

Desired Delivery Date. Activated on request by customer.

district_area

object (DistrictArea)

District Area

location

string (ewkt)

Geographical location as EWKT representation

name

string

Name of District Area

duration

integer

Duration. Activated on request by customer.

expire_date

string (date-time)

Expire Date

first_contact

string

First contact person for plan. Not shown when displaying plan details in related objects. Activated on request by customer.

integer

Unique id of plan

implementation_begin_end

string (date-time)

Implementation Date. Activated on request by customer.

implementation_date

string (date)

Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.

latest_implementation_date

string (date)

Latest Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.

list_url

string (url)

URL to the list of all Plans. Only shown when displaying plan details in related objects.

location

string (ewkt)

Geographical location. As EWKT representation

louhi_id

string

Louhi ID. Activated on request by customer.

modifications

string

Modifications. Not shown when displaying plan details in related objects. Activated on request by customer.

name

string

Name of Plan

network

object (PlanNetworkType)

Plan Network 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[ "PLAN_NETWORK_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

network_owner

object (PlanNetworkOwner)

Plan Network Owner

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

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

offer_accepted_date

string (date-time)

Offer Accepted Date. Activated on request by customer.

offer_id

string

Offer ID. Activated on request by customer.

parentplan

string (url)

URL to the plan of which the plan is part of (subplan). Available from version 3.2.24. Activated on request by customer.

plan_remark

string

Plan remark. Not shown when displaying plan details in related objects. Activated on request by customer.

plumbing_start_date

string (date-time)

Plumbing Start Date. Activated on request by customer.

property_address

string

Property address. Not shown when displaying plan details in related objects. Activated on request by customer.

publicity

object (PlanPublicity)

Plan Publicity

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

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

state

object (PlanState)

Plan state

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

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

total_cost

number (float)

Sum of cost for all related objects for the plan. Not shown when displaying plan details in related objects. Activated on request by customer.

type

object (PlanType)

Plan 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[ "PLAN_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

updated_by

string

Updated by

updated_date

string (date-time)

Update Date

work_activities

string

Work Activities. Activated on request by customer.

work_phase

object (PlanWorkPhase)

Plan Work Phase

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

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

work_project

string

Work Project. Activated on request by customer.

work_type

object (PlanWorkType)

Plan Work 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[ "PLAN_WORK_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

work_type_main

object (PlanWorkTypeMain)

Plan Work Type Main

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

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

work_type_sub

object (PlanWorkTypeSub)

Plan Work Type Sub

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

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

procedure

object (Procedure)

Procedure

groupname

Group name of constant

Valid values[ "PROCEDURE" ]

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

processed

boolean

Is survey file processed or not

rawText

string

raw text of the file attached to the survey file

srid

integer

Srid of the survey file

surveyAmount

integer

Amount of surveys in the file

updatedBy

string

updated by user

updatedDate

string (date-time)

updated date

updatedBy

string

User who last updated the survey line string

updatedTs

string (date-time)

Last updated timestamp

zCoord

string

Z-coordinate

Total

integer

Number of Survey Line Strings 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

Create Survey Line String