LvWS
LV Web Service, version 2.2.27
Adapted for public use.
Exceptions for all operations are wrapped in Exception.xsd.
Several methods contain parameters and return values which are domain values in LV. The explanation of these, and their valid values, can be found by calling the GetDomainValues method (e.g. Job statuses, Object types, etc.)
Contact the service provider for an api key.
The following operations are supported. For a formal definition, please review the Service Description.
-
CountAttributeValuesForAttribute
Returns the value count for every unique attribute value for an attribute.
apiKey - the api key.
featureTypeName - name of the feature type which the attribute to be counted belongs to.
attributeName - attribute name of the feature type to do the value count for.
Response-XSD
-
CountFeaturesForFeatureType
Returns the number of features for a feature type in LV.
Input a feature type to count that feature type only.
apiKey - the api key.
featureTypeName - name of the feature type to do the feature count for. Leave empty for all feature types.
Response-XSD -
GetConnectedLinks
Returns a list of link parts for a given link.
Each link part is described by a start node with its connecting links and an end node with its connecting links.
apiKey - the api key.
trafficTypes - traffic type bitmask. -1 = all traffic types, 1 = Car, 2 = Bicycle, 3 = Car and bicycle, 4= Ferry, 8 = Pedestrian, etc.
linkId - link id of a reference link. Please Note! This method is not implemented for function objects, only for reference links!
Response-XSD -
GetDataCatalog
Returns feature types with attributes and attribute types with valid values and intervals.
apiKey - the api key.
featureTypeIds - list of feature type identities (semicolon separated). Leave empty to get all feature types.
includeAttributeTypes - set to true to include attributeTypes in the result.
Note: When requesting a limited group of feature types, and also requesting attribute types to be included - only attribute types used by the requested feature types are returned. When not filtering feature types - all attribute types in the system are returned, no matter whether they are used by any feature types or not. This is by design.
Response-XSD -
GetDomainValues
Returns the possible values for domain entries.
apiKey - the api key.
Response-XSD -
GetFeatureChanges
Returns a list of feature changes that have occurred since a given date and time (changedSince).
apiKey - the api key.
featureTypes - a list of feature type ids to search for (semicolon separated).
changedSince - changed since time. Date and time of format yyyyMMddHHmm.
The result is returned as a LvSubscribedChangeList.
Response-XSD -
GetFeatureList
Returns a list of lightweight features, given a list with their object identities.
apiKey - the api key.
objectIds - a list with feature object ids to search for (semicolon separated).
Response-XSD -
GetFeatureListForLinks
Returns a list of lightweight features that lie on the given links.
apiKey - the api key.
linkIds - a list with link ids (semicolon separated).
featureTypeIds - a list with feature types to search for (semicolon separated). Leave empty to get features of all feature types.
Response-XSD -
GetFeatureListForSearchConditions
Returns a list of lightweight features that match given criteria.
apiKey - the api key.
searchConditionsXmlString - the search conditions. XSD Example-XML
The search condition (criteria) must contain a feature type, but everything else is optional.
The feature type sub condition can have both attribute conditions and an extent specifying condition, where the extent specifying condition
is a feature type condition that states that the search will only include the features for which the extents overlap the extents for the extent specifying condition.
An optional street name condition may be included to limit the result to a specific street. It may contain wildcards (? and *).
An optional district condition may also be included in the search, as a list of district IDs.
An optional geometry condition may also be included in the search containing a polygon WKT.
Response-XSD -
GetFeatures
Returns features given a list of their object identities.
apiKey - the api key.
objectIds - list of the feature object identities (semicolon separated).
includeWktForExtents - is used to receive the geometries for the extents, concatenated in a WKT string.
Response-XSD -
GetIntersections
Returns a geometry on WKT (MULTIPOINT) with coordinates for all intersections between two streets given their street names.
apiKey - the api key.
streetNameOne - first street name of the intersection.
streetNameTwo - second street name of the intersection.
trafficTypes - a traffic types bitmask that limits the search result. -1 = all traffic types, 1 = Car, 2 = Bicycle, 4= Ferry, 8 = Pedestrian
Response-XSD -
GetLinkChanges
Returns a list of link changes that have occurred since a given date and time (changedSince).
apiKey - the api key.
changedSince - changed since time. Date and time of format yyyyMMddHHmm.
The result is returned as a LvSubscribedChangeList.
Response-XSD -
GetLinks
Returns links given a list of link identities.
apiKey - the api key.
linkIds - list of link ids (semicolon separated).
includeWkt - set to true to include WKT geometries for each link in the result.
Response-XSD -
GetLinksForSearchConditions
Returns a list of links that match the search conditions.
apiKey - the api key.
searchConditionsXmlString - the search conditions. XSD Example-XML At least one condition must contain a feature/street name/district/trafficTypes.
The feature conditions can include one or many different feature types.
Each feature type condition can have both attribute conditions and an extent specifying condition,
which is a feature type condition that states that the search will only include the
features for which the extents overlap the extents for the extent specifying condition.
An optional trafficTypes condition may be included to limit the result, It is a bitmask, where Car=1, Bicycle=2, Ferry=4, Pedestrian=8, Rescue=16.
An optional street name condition may be included to limit the result to a specific street. It may contain wildcards (? and *).
An optional district condition may also be included in the search, as a list of district IDs.
An optional geometry condition may also be included in the search containing a polygon WKT.
includeWkt - set to true to include WKT geometries for each link in the result.
Response-XSD -
GetLinksForStreetName
Returns a list with links.
apiKey - the api key.
trafficTypes - a traffic types bitmask that limits the search result. Input -1 to ignore traffic types.
maxNrOfResults - limits the result.
streetNamePattern - limits the search to links that fullfill the defined street name pattern. Use * and ? as wildcards.
includeWkt - set to true to include WKT geometries for each link in the result.
Response-XSD -
GetNearestFeatureList
Returns a list of geocoded lightweight features that lie closest to a position.
apiKey - the api key.
easting - easting ordinate.
northing - northing ordinate.
maxDistance - maximum distance to search for. Must be between 0 - 2000.
maxNrOfResults - limits the results.
featureTypeName - limits the search to features with given feature type name.
Response-XSD -
GetNearestLinks
Returns a list of geocoded links that lie closest to a position.
apiKey - the api key.
easting - easting ordinate.
northing - northing ordinate.
trafficTypes - a traffic type bitmask that limits the search result. Input -1 to not limit the result.
maxDistance - maximum distance to search for. Must be between 0 - 2000.
maxNrOfResults - limits the results.
streetNamePattern limits the search to links that fullfill the defined street name pattern. Use * and ? as wildcards.
includeWkt - set to true to include WKT geometries for each link in the result.
Response-XSD -
GetStreetNames
Returns street names given a search condition.
apiKey - the api key.
streetNamePattern - a search string (with * and ? as wildcards).
optionalMunicipality - municipality (optional).
optionalPostalArea - postal area (optional).
optionalPostalCode - postal code/zip code (optional).
Response-XSD -
GetStreetNamesWithinLevenshteinDistance
Returns street names with a tolerance for spelling errors.
apiKey - the api key.
streetName - the street name.
maxDistance - the maximum Levenshtein distance.
optionalMunicipality - municipality (optional).
optionalPostalArea - postal area (optional).
optionalPostalCode - postal code/zip code (optional).
Response-XSD -
GetSupportedSpatialReferenceSystems
Returns the spatial reference systems that are supported and which one of them LV use internal.
apiKey - the api key.
Response-XSD Example-XML -
TransformGeometry
Transforms a WKT geometry to another spatial reference system.
For a list of valid spatial reference systems, see method GetSupportedSpatialReferenceSystems.
apiKey - the api key.
wkt - a wkt representation of the geometry to transform.
fromSrid - the spatial reference system id of the geometry.
toSrid - the spatial reference system id to which to transform the geometry.
Response-XSD -
TranslateLvToNvdb
Translates LV object IDs to corresponding NVDB IDs.
apiKey - the api key.
objectIds - a list of LV object IDs (semicolon separated).
The result is a list of LvdNvdbIdentity objects.
Response-XSD -
TranslateNvdbToLv
Translates NVDB IDs to corresponding LV object IDs.
apiKey - the api key.
nvdbIds - list of NVDB IDs. A comma separated tuple of NVDB oid_pid and oid_sid. Multiple NVDB IDs are separated with semicolons. Eg. 2,1481499;2,1481500;19191,3892321
The result is a list of LvdNvdbIdentity objects.
Response-XSD -
Version
Returns the web service's version.
apiKey - the api key.
Response-XSD