Get Survey Line String Details
- 28 Aug 2024
- 12 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get Survey Line String Details
- Updated on 28 Aug 2024
- 12 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/survey-lines/{id}/
Operation is used to get details of a Survey Line String. Available from product version 2024.3.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Survey Line String ID
Responses
200
Survey Line String
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" ]
id
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
id
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" ]
id
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
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" ]
id
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" ]
id
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" ]
id
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
id
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" ]
id
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" ]
id
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)
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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.
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 (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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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" ]
id
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
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?
