Contents x
    Get Point details
    • 17 Jan 2024
    • 5 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get Point details

    • Updated on 17 Jan 2024
    • 5 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get
    /keycore-point/{id}/

    Operation is used to retrieve full details of given Point Id

    Security
    API Key
    Header parameter nameAuthorization

    Token issued for API consumer.

    Path parameters
    id
    integerRequired

    Id of Point

    Responses
    200

    Retrieved Point (object)

    Expand All
    object
    Plan
    object (Plan)

    Plan

    Branch_line
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    Center_measure
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    Construction
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    Excavation
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    Limiter
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    Plan_piping
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    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 (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    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.

    id
    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 (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    network_owner
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    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 (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    state
    object (PlanState)

    Plan state

    groupname

    Group name of constant

    Valid values[ "PLAN_STATE" ]
    id
    integer

    Unique id of constant

    list_url
    string (url)

    Url to fetch all contants from this group

    logical_txt
    string

    Logical textual value

    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

    groupname

    Group name of constant

    Valid values[ "PLAN_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

    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 (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    work_project
    string

    Work Project. Activated on request by customer.

    work_type
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    work_type_main
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    work_type_sub
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    angle
    number (float)

    Angle

    created_by
    string

    Created by

    created_ts
    string (date)

    Creation date

    description
    string

    Description

    distance
    number (float)

    Distance

    haccuracy
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    history_date
    string (date)

    History date

    id
    integer

    Primary key

    identification
    string

    Identification

    length
    number (float)

    Length

    location
    string (ewkt)

    Location

    location_accuracy
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    mapper
    string

    Mapper

    mapping_method
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    scale
    number (float)

    Scale

    state
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    survey_amount
    integer

    Survey amount

    type
    object (PointType)
    category
    object (TxtConstant)
    groupname
    string

    Group name of constant. Same as groupname parameter.

    id
    integer

    Unique id of constant

    logical_txt
    string

    Logical textual value

    txt
    string

    Human readable textual representation (translated)

    id
    integer

    Primary key

    label
    string

    Label

    name
    string

    Name

    symbol_name
    string

    Symbol Name

    updated_by
    string

    Updated by

    updated_ts
    string (date)

    Update date

    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?
    What's Next
    Products
    Company
    Our Mission
    Connect With Us
    Support
    Copyright © Keypro Oy. All Rights Reserved