Get Keydh Node details
- 17 Jan 2024
- 7 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get Keydh Node details
- Updated on 17 Jan 2024
- 7 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/keydh-node/{id}/
Operation is used to retrieve full details of given Keydh Node Id
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of Keydh Node
Responses
200
Retrieved Keydh Node (object)
object
KeydhNode
Addres
object (Apartment)
address
object (Address)
buildingId
string
Building id
city
string
Building city name
cityAlt
string
Building city name in alternative language
country
string
Building country
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
district
string
Building district
id
integer
Primary key
location
string (ewkt)
Geographical location
municipality
string
Building municipality
propertyId
string
Property number
province
string
Building province
streetname
string
Building street name
streetnameAlt
string
Building street name in alternative language
streetno
string
Building number
subdivision
string
Building municipality subdivision
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usagePurpose
object (BuildingUsage)
Building usage purpose
groupname
Group name of constant
Valid values[ "BUILDING_USAGE" ]
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
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
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
zipcode
string
Building zipcode
apartmentDivision
string
apartment division
apartmentLetter
string
apartment letter
apartmentNumber
string
apartment number
id
integer
Primary key
originProperty
string
apartment original property id
originalStreetno
string
apartment original streen number
usagePurpose
object (ApartmentUsage)
Apartment Usage purpose
groupname
Group name of constant
Valid values[ "APARTMENT_USAGE" ]
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
usagePurposeAlt
object (AddressSecondaryUsage)
Address usage purpose
groupname
Group name of constant
Valid values[ "KN_ADDR_SPEC" ]
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
usageState
object (ApartmentStatus)
Apartment status
groupname
Group name of constant
Valid values[ "APARTMENT_STATUS" ]
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
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)
accuracy_id
object (SnConstants)
groupname
string
Group name of constant. Group name must contain only uppercase letters separated by underscores.
id
integer
Primary key
num_value
integer
Numerical value of the constant
orderno
integer
Order number
txt
string
Human readable textual representation
txt_2
string
Human readable textual representation
value
string
Logical textual value
angle
number (float)
Angle
area
object (DhDivision)
area_id
object (DhArea)
mslink
integer
Primary key
name
string
Name
created_by
string
Creator
created_ts
string (date-time)
Date created
location
string (ewkt)
Geographical location
mslink
integer
Primary key
name
string
Name
remarks
string
Remarks
updated_by
string
Updated by
updated_ts
string (date-time)
Date updated
construction_year
integer
Construction year
created_by
string
Created by
created_ts
string (date-time)
Date created
h_accuracy_id
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
lbl_angle_exp
string
Export label angle
lbl_color_exp
string
Export label color
lbl_size_exp
string
Export size color
location
string (ewkt)
Geographical 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_id
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_id
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)
note
string
Additional details
owner_id
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)
position_id
string
Position id
scale
number (float)
Scale
state_id
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
string
Survey amount
sym_angle_exp
string
Export symbol angle
sym_code_gt
string
Symbol code
sym_color_exp
string
Export symbol color
sym_name_exp
string
Export symbol name
sym_size_exp
string
Export symbol size
sym_text_exp
string
Export symbol text
sym_width_exp
string
Export symbol width
type_id
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)
updated_by
string
Updated by
updated_ts
string (date-time)
Date updated
z_coord
number (float)
z-coordinate
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?
