MENU
    Get list of Points
    • 28 Oct 2024
    • 14 Minutes to read
    • Contributors
    • Dark
    • PDF

    Get list of Points

    • Dark
    • PDF

    Article summary

    Get
    /keycore-points/

    Operation is used to get a list of Points.

    Points 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.

    Example
    {
      "angle": 90.00000000000001,
      "color": "",
      "created_by": "test user",
      "created_ts": "2022-10-11T05:34:30Z",
      "description": "",
      "distance": "0.0",
      "haccuracy": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "H_ACCURACY",
        "id": 117210,
        "list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/H_ACCURACY/",
        "logical_txt": "Ei määritelty",
        "num_value": 1.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Ei määritelty"
      },
      "history_date": null,
      "id": 10,
      "identification": "",
      "installYear": 2023,
      "length": "0.0",
      "location": "SRID=3067;POINT Z (458823.6567999999970198 6697544.1913999998942018 0.0000000000000000)",
      "location_accuracy": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "LOCATION_ACCURACY",
        "id": 8301,
        "list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
        "logical_txt": "2.0m",
        "num_value": 2.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": 2.0,
        "txt": "2.0m"
      },
      "mapper": "",
      "mapping_method": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "MAPPING_METHOD",
        "id": 390,
        "list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/MAPPING_METHOD/",
        "logical_txt": "Digitoitu",
        "num_value": 4.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Digitoitu"
      },
      "plan": null,
      "point_type": {
        "category": {
          "availability_end_ts": null,
          "availability_start_ts": null,
          "available": true,
          "groupname": "POINT_TYPE_CATEGORY",
          "id": 242790,
          "list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/POINT_TYPE_CATEGORY/",
          "logical_txt": "KeyRNS",
          "num_value": -1.0,
          "num_value2": null,
          "num_value3": null,
          "num_value4": null,
          "txt": "Telesymbolit"
        },
        "id": 1002,
        "label": "Merkkiantenni",
        "list_url": "http://10.121.8.101:8055/api/v2/point-types",
        "name": "MERKKIANTENNI",
        "symbol_name": "merkkiant"
      },
      "scale": null,
      "size": null,
      "state": null,
      "survey_amount": ""
    }
    JSON
    Collapse all
    object
    Next
    string (url)

    Url to next page of Points list. Null if No next page exist

    Prev
    string (url)

    Url to previous page of Points list. Null if No previous page exist

    Results
    Array of object (Point)

    List of fetched Points

    object

    Point

    Owner
    object (TxtConstant)
    Renter
    object (TxtConstant)
    angle
    number (float)

    Point rotation

    color
    string

    Point color

    created_by
    string

    Creator

    created_ts
    string (date-time)

    Creation date and time

    description
    string

    Additional details

    distance
    number (float)

    Distance

    haccuracy
    object (HeightAccuracy)

    Height accuracy

    history_date
    string (date)

    Mapping date

    id
    integer

    Unique id of point

    identification
    string

    Identification of point

    installYear
    integer

    Install year. Available from product version 3.6.8.

    length
    number (float)

    Length

    location
    string (ewkt)

    Geographical location

    location_accuracy
    object (LocationAccuracy)

    Location accuracy

    mapper
    string

    Mapper

    mapping_method
    object (MappingMethod)

    Mapping method

    plan
    object (Plan)

    Plan

    point_type
    object (PointType)

    Point Type

    safety_distance
    object (SafetyDistance)

    Safety Distance

    scale
    number (float)

    Point scale

    size
    integer

    Point size

    state
    object (TxtConstant)
    survey_amount
    string

    Survey amount

    updated_by
    string

    Last updater

    updated_ts
    string (date-time)

    Last updated date and time

    Total
    integer

    Total number of Point in the list

    401

    Authentication credentials are missing or invalid

    Example
    {
      "details": "Authentication credentials were not provided"
    }
    JSON
    object
    details
    string

    Detailed description of error

    Authentication
    Token
    *
    URL
    Base URL
    /api/v2
    Parameters
    offset
    limit
    __any of the object fields__
    orderby
    Response
    Click Try It! to start a request and see the response here!
    Code Samples

    Was this article helpful?

    Authentication
    Token
    *
    URL
    Base URL
    /api/v2
    Parameters
    offset
    limit
    __any of the object fields__
    orderby
    Response
    Click Try It! to start a request and see the response here!
    Code Samples