# MapCenter Documentation 4.3.3.0

# Application Programming Interface

Copyright (c) 2014 Emapa S.A.

## Index

1. Modules
   1. BaseModule
   2. MapModule
   3. SearchModule
   4. LocalizeModule
   5. ObjectsModule
   6. RoutePlannerModule
   7. RouteRepositoryModule
   8. RouteAttributesModule
   9. RouteOptimizerModule
2. Functions

1. Base module
   1. ActivateMapFile
   2. AdminDropSession
   3. AuthCreateGroup
   4. AuthCreateUser
   5. AuthDeleteGroup
   6. AuthDeleteUser
   7. AuthGetGroup
   8. AuthGetGroupsList
   9. AuthGetUserParamEx
   10. AuthGetUserParams
   11. AuthGetUsersList
   12. AuthModifyGroup
   13. AuthModifyUser
   14. AuthModifyUserPassword
   15. AuthSetUserParamEx
   16. CreateSessionID
   17. DeactivateMapFile
   18. DropSession
   19. GetActiveSessions
   20. GetAvailableMapFiles
   21. GetCurrentSessionCount
   22. GetCurrentViewConfig
   23. GetLoadedMapsRegion
   24. GetMapModules
   25. GetMaxSessionsCount
   26. GetServerVersion
   27. GetSessionComment
   28. GetSessionLanguageContext
   29. GetSessionLifetimeSeconds
   30. GetViewConfigList
   31. KeepSession
   32. LoadCurrentViewConfig
   33. ReloadMapFiles
   34. ServiceConfigGetServiceParams
   35. ServiceConfigSetServiceParam
   36. SetCurrentViewConfig
   37. SetSessionComment
   38. SetSessionLanguageContext
2. Map module
   1. ConvertMapToScreen
   2. ConvertScreenToMap
   3. Degeocode
   4. DegeocodeAtPoint
   5. DegeocodeEx
   6. DegeocodeExWithAttributes
   7. DegeocodeGetParamValue
   8. DegeocodeSetParamValue
   9. ForwardCalc
   10. GetAvailableIconFormats
   11. GetAvailableImageFormats
   12. GetDefaultLayers
   13. GetDegeocodeLayers
   14. GetMapPointLength
   15. GetProjections
   16. GetScreenPointLength
   17. GetTiledMapLayers
   18. InverseCalc
   19. RenderMapOnHWNDByPoint
   20. RenderMapOnHWNDByPointWithCopyright
   21. RenderMapOnHWNDByRect
   22. RenderMapOnHWNDByRectWithCopyright
   23. RenderMapOnImageByPoint
   24. RenderMapOnImageByPointWithCopyright
   25. RenderMapOnImageByRect
   26. RenderMapOnImageByRectWithCopyright
   27. RenderSplitMapOnImageByPoint
   28. RenderSplitMapOnImageByPointWithCopyright
   29. RenderSplitMapOnImageByRect
   30. RenderSplitMapOnImageByRectWithCopyright
   31. RenderTiledMap
   32. RenderTiledMapEx
   33. RenderTiledMapWithCopyright
3. Search module
   1. ClearMapSelection
   2. Geocode
   3. GeocodeEx
   4. MultiGeocodeEx
   5. SearchAddCityToSelection
   6. SearchAddObjectToSelection
   7. SearchAddStreetCrossingToSelection
   8. SearchAddStreetWithNumToSelection
   9. SearchGetCityList
   10. SearchGetCityListEx
   11. SearchGetCountryList
   12. SearchGetItemKindList
   13. SearchGetItemsList
   14. SearchGetParamValue
   15. SearchGetParamValues
   16. SearchGetStreetHandle
   17. SearchInitialize
   18. SearchSelectCities
   19. SearchSelectItems
   20. SearchSelectItemsEx
   21. SearchSetItemsFilter
   22. SearchSetParamValue
4. Localize module
   1. LocalizeAddObjectPositions
   2. LocalizeGetObjectVisibility
   3. LocalizeIconAdd
   4. LocalizeIconClear
   5. LocalizeIconGet
   6. LocalizeIconGetCount
   7. LocalizeIconIDToItemIndex
   8. LocalizeIconRemove
   9. LocalizeIconSet
   10. LocalizeNumFieldsAdd
   11. LocalizeNumFieldsClear
   12. LocalizeNumFieldsGet
   13. LocalizeNumFieldsGetCount
   14. LocalizeNumFieldsRemove
   15. LocalizeNumFieldsSet
   16. LocalizeObjectAdd
   17. LocalizeObjectAddWithPositions
   18. LocalizeObjectClear
   19. LocalizeObjectEntityIDToItemIndex
   20. LocalizeObjectGet
   21. LocalizeObjectGetCount
   22. LocalizeObjectPositionAdd
   23. LocalizeObjectPositionClear
   24. LocalizeObjectPositionGet
   25. LocalizeObjectPositionGetCount
   26. LocalizeObjectPositionRemove
   27. LocalizeObjectPositionSet
   28. LocalizeObjectRemove
   29. LocalizeObjectSet
   30. LocalizeSetObjectVisibility
   31. LocalizeStrFieldsAdd
   32. LocalizeStrFieldsClear
   33. LocalizeStrFieldsGet
   34. LocalizeStrFieldsGetCount
   35. LocalizeStrFieldsRemove
   36. LocalizeStrFieldsSet
5. Objects module
   1. AddGroupIcon
   2. AppendGroup
   3. AppendObject
   4. AppendObjectCircle
   5. AppendObjectEllipse
   6. AppendObjectPolygon
   7. AppendObjectPolyline
   8. AppendObjectRectangle
   9. AppendObjects
   10. CancelEditGroup
   11. CancelEditObject
   12. CancelEditObjectFields
   13. CheckUpdate
   14. ClearSetFilter
   15. CreateObjectSet
   16. DeleteGroup
   17. DeleteGroupIcon
   18. DeleteObject
   19. DeleteObjects
   20. DeleteObjectShape
   21. EditGroup
   22. EditObject
   23. EditObjectFields
   24. FilterByObjectShape
   25. FilterByPoint
   26. FilterByRadius
   27. FilterByShape
   28. FilterByText
   29. GetAggregatedObjects
   30. GetAggregatedObjectShapes
   31. GetDatabaseList
   32. GetDatabaseTableList
   33. GetGroupBinaryData
   34. GetGroupIcon
   35. GetGroupIcons
   36. GetGroupSettings
   37. GetGroupShapeSettings
   38. GetModifiedFields
   39. GetNextResult_FieldSet
   40. GetNextResult_IDSet
   41. GetNextResult_PositionSet
   42. GetNextResult_RemovedSet
   43. GetNextResult_Set
   44. GetNextResult_UpdatedSet
   45. GetObject
   46. GetObjectAggregates
   47. GetObjectBinaryData
   48. GetObjectCircles
   49. GetObjectCount
   50. GetObjectEllipses
   51. GetObjectFields
   52. GetObjectPolygons
   53. GetObjectPolylines
   54. GetObjectRectangles
   55. GetRemovedFields
   56. GetVisibleGroups
   57. MapBaseConnect
   58. MapBaseDisconnect
   59. MapBaseLoadFromBlob
   60. MapBaseStoreToBlob
   61. PostGroup
   62. PostObject
   63. PostObjects
   64. SetGroupBinaryData
   65. SetGroupShapeSettings
   66. SetObjectBinaryData
   67. SetObjectFields
   68. SetObjectIDs
   69. SetVisibleGroups
6. RoutePlanner module
   1. RoutePlannerCalculatePointDistanceFromRoute
   2. RoutePlannerCalculatePointWithinRouteBuffer
   3. RoutePlannerCalculateRoute
   4. RoutePlannerCalculateRouteDistanceMatrix
   5. RoutePlannerCalculateRouteFromGPSTrack
   6. RoutePlannerCalculateRoutesWithMultipleDepots
   7. RoutePlannerCalculateRoutesWithSingleDepot
   8. RoutePlannerCalculateRouteWithBinaryResult
   9. RoutePlannerDriverParamsGet
   10. RoutePlannerDriverParamsSet
   11. RoutePlannerEntriesAdd
   12. RoutePlannerEntriesAddWithDescription
   13. RoutePlannerEntriesClear
   14. RoutePlannerEntriesGet
   15. RoutePlannerEntriesGetCount
   16. RoutePlannerEntriesGetWithSnapPoints
   17. RoutePlannerEntriesSet
   18. RoutePlannerEntriesSetAsDriveThrough
   19. RoutePlannerEntriesSetWithDescription
   20. RoutePlannerEntryAdd
   21. RoutePlannerEntryAddWithDescription
   22. RoutePlannerEntryComplexMove
   23. RoutePlannerEntryGet
   24. RoutePlannerEntryInsert
   25. RoutePlannerEntryInsertWithDescription
   26. RoutePlannerEntryMove
   27. RoutePlannerEntryRemove
   28. RoutePlannerEntryReverse
   29. RoutePlannerEntrySet
   30. RoutePlannerEntrySetWithDescription
   31. RoutePlannerGetAvailableRoadTypes
   32. RoutePlannerGetParamValue
   33. RoutePlannerGetParamValues
   34. RoutePlannerGetRouteItinerary
   35. RoutePlannerGetRouteLogisticTOLLSummary
   36. RoutePlannerGetRouteRepresentation
   37. RoutePlannerGetRouteRepresentationWithBinaryResult
   38. RoutePlannerGetRouteSummary
   39. RoutePlannerGetRouteViaTollSummary
   40. RoutePlannerRoadParamsGet
   41. RoutePlannerRoadParamsSet
   42. RoutePlannerRoadViaTollParamsGet
   43. RoutePlannerRoadViaTollParamsSet
   44. RoutePlannerRouteClear
   45. RoutePlannerRouteLoadFromBlob
   46. RoutePlannerRouteLoadFromDatabase
   47. RoutePlannerRouteStoreToBlob
   48. RoutePlannerRouteStoreToDatabase
   49. RoutePlannerSetParamValue
   50. RoutePlannerSimpleCalculateRoute
   51. RoutePlannerSimpleCalculateRoute2
   52. RoutePlannerSimpleCalculateRoute2WithBinaryResult
   53. RoutePlannerSimpleCalculateRoute3
   54. RoutePlannerSimpleCalculateRoute3WithBinaryResult
   55. RoutePlannerSimpleCalculateRouteWithBinaryResult
   56. RoutePlannerVehicleParamExGet
   57. RoutePlannerVehicleParamExSet
   58. RoutePlannerVehicleParamsExGet
   59. RoutePlannerVehicleParamsGet
   60. RoutePlannerVehicleParamsGet2
   61. RoutePlannerVehicleParamsSet
   62. RoutePlannerVehicleParamsSet2
   63. VehicleRepositoryAddVehicle
   64. VehicleRepositoryDriverParamsGet
   65. VehicleRepositoryDriverParamsSet
   66. VehicleRepositoryRemoveVehicle
   67. VehicleRepositoryRoadParamsGet
   68. VehicleRepositoryRoadParamsSet
   69. VehicleRepositoryVehicleFetch
   70. VehicleRepositoryVehicleGet
   71. VehicleRepositoryVehicleReplace
   72. VehicleRepositoryVehiclesClear
   73. VehicleRepositoryVehicleSet
   74. VehicleRepositoryVehiclesGet
   75. VehicleRepositoryVehiclesSet
   76. VehicleRepositoryVehicleViaTollGet
   77. VehicleRepositoryVehicleViaTollSet
7. RouteRepository module
   1. RoutePlannerCalculateAlternativeRoutesAndStore
   2. RoutePlannerCalculateRoutesWithMultipleDepotsAndStore
   3. RoutePlannerCalculateRoutesWithSingleDepotAndStore
   4. RoutePlannerSimpleCalculateAlternativeRoutesAndStore
   5. RouteRepositoryAddRoute
   6. RouteRepositoryAddRouteWithIdent
   7. RouteRepositoryCalculatePointDistanceFromRoute
   8. RouteRepositoryClear
   9. RouteRepositoryFetchRoute
   10. RouteRepositoryFetchRouteWithIdent
   11. RouteRepositoryGetRouteItinerary
   12. RouteRepositoryGetRouteItineraryByIdent
   13. RouteRepositoryGetRouteRepresentation
   14. RouteRepositoryGetRouteRepresentationByIdent
   15. RouteRepositoryGetRoutes
   16. RouteRepositoryGetRoutesCount
   17. RouteRepositoryGetRouteSummary
   18. RouteRepositoryGetRouteSummaryByIdent
   19. RouteRepositoryLoadFromBlob
   20. RouteRepositoryRemove
   21. RouteRepositoryRemoveWithIdent
   22. RouteRepositoryReplaceRoute
   23. RouteRepositoryReplaceRouteWithIdent
   24. RouteRepositorySetRouteColor
   25. RouteRepositorySetRouteColorByIdent
   26. RouteRepositorySetRouteDescription
   27. RouteRepositorySetRouteDescriptionByIdent
   28. RouteRepositorySetRouteVisibility
   29. RouteRepositorySetRouteVisibilityByIdent
   30. RouteRepositoryStoreToBlob
8. RouteAttributes module
   1. RouteAttributesAddAlongRouteAttribute
   2. RouteAttributesAddLineAttribute
   3. RouteAttributesAddPointAttribute
   4. RouteAttributesAddPolygonAttribute
   5. RouteAttributesClearRouteAttribute
   6. RouteAttributesDeleteRouteAttribute
   7. RouteAttributesExecuteDataProviderAction
   8. RouteAttributesGetAttributesProviderList
   9. RouteAttributesGetDataProviderActions
   10. RouteAttributesGetDataProviderParams
   11. RouteAttributesGetPassedAttributesList
   12. RouteAttributesGetRouteAttribute
   13. RouteAttributesGetRouteAttributes
   14. RouteAttributesGetRouteAttributeWithGeometry
   15. RouteAttributesGetSubscribedProvidersList
   16. RouteAttributesLoadFromBlob
   17. RouteAttributesModifyAlongRouteAttribute
   18. RouteAttributesModifyLineAttribute
   19. RouteAttributesModifyPointAttribute
   20. RouteAttributesModifyPolygonAttribute
   21. RouteAttributesSetDataProviderParam
   22. RouteAttributesSetRouteAttribute
   23. RouteAttributesStoreToBlob
   24. RouteAttributesSubscribeToDataProvider
   25. RouteAttributesUnsubscribeFromDataProvider
9. RouteOptimizer module
   1. RouteOptimizerAddEntryDeliveryShipment
   2. RouteOptimizerAddEntryDeliveryShipments
   3. RouteOptimizerAddEntryPickupShipment
   4. RouteOptimizerAddEntryPickupShipments
   5. RouteOptimizerAddEntryTimeWindow
   6. RouteOptimizerAddEntryTimeWindows
   7. RouteOptimizerAddShipmentType
   8. RouteOptimizerClearEntryDeliveryShipments
   9. RouteOptimizerClearEntryPickupShipments
   10. RouteOptimizerClearEntryTimeWindows
   11. RouteOptimizerGetDepotEntry
   12. RouteOptimizerGetEntryDeliveryShipments
   13. RouteOptimizerGetEntryPickupShipments
   14. RouteOptimizerGetEntryShipmentDeliveryPickupTimes
   15. RouteOptimizerGetEntryTimeWindows
   16. RouteOptimizerOptimizeRoute
   17. RouteOptimizerRemoveShipmentType
   18. RouteOptimizerSetDepotEntry
   19. RouteOptimizerSetEntryDeliveryShipments
   20. RouteOptimizerSetEntryPickupShipments
   21. RouteOptimizerSetEntryShipmentDeliveryPickupTimes
   22. RouteOptimizerSetEntryTimeWindows
   23. RouteOptimizerShipmentTypesClear
   24. RouteOptimizerShipmentTypesGet
   25. RouteOptimizerShipmentTypesSet
   26. RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd
   27. RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear
   28. RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet
   29. RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet
   30. RouteOptimizerSimpleOptimizeRoute
   31. RouteOptimizerSolveProblem
   32. RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd
   33. RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear
   34. RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet
   35. RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet

3. Types

1. TUID
2. TColor
3. TSessionID
4. TConnectionString
5. TRecordID
6. TGeocodeStatus
7. TCaptionPosition
8. TSoapTRectsArray
9. TSoapTLongLatRectArray
10. TWideStringArray
11. TSoapTLongLatPointArray
12. TSoapTLongLatPoint2DArray
13. TSoapTPointsArray
14. TCaptionPositionArray
15. TSoapTObjectPositionArray
16. TBooleanArray
17. TByteArray
18. TSoapTIconPropertiesArray
19. TDynamicIntegerArray
20. TBlobArray
21. TSoapTDegeocodeResultArray
22. TSoapTDegeocodeCityElementResultArray
23. TSoapTDegeocodeRoadElementResultArray
24. TSoapTDegeocodeExResultEntryArray
25. TSoapTDegeocodeAtPointResultArray
26. TSoapTDegeocodeAtPointDatabaseResultArray
27. TSoapTGeocodePointInfoArray
28. TSoapTGeocodePointInfoExArray
29. TSoapTMultiGeocodePointInfoExArray
30. TDynamicByteArray
31. TFloatArray
32. TSoapTMapFileEntryArray
33. TSoapTFloatArrayArray
34. TSoapTWideStringArrayArray
35. TSoapTBooleanArrayArray
36. TSoapTLocalizeObjectPositionDataArray
37. TSoapTSessionEnumArray
38. TSoapTViewConfigListArray
39. TSoapTRepositoryRouteArray
40. TSoapTRouteAttributeParamsArray
41. TSoapTRouteAttributePassedArray
42. TSoapTDriveThroughArray
43. TSoapTTimeWindowsArray
44. TSoapTShipmentsArray
45. TSoapTRouteOptimalizationEntryArray
46. TSoapTRouteOptimizerResultRoutesArray
47. TSoapTRouteOptimizerEntry2Array
48. TSoapTRouteOptimizerEntryAction2Array
49. TSoapTRouteOptimizerShipmentMovesArray
50. TSoapTRouteOptimizerEntryArray
51. TSoapTRouteOptimizerShipmentActionArray
52. TSoapTRouteItineraryArray
53. TSoapTRoadParamsArray
54. TSoapTRoadViaTollParamsArray
55. TSoapTRoadResultsArray
56. TSoapTViaTollRoadResultsArray
57. TSoapTLogisticTOLLResultsArray
58. TSoapTVehicleEntryArray
59. TSoapTVehicleCategoryToShipmentTypeIncompatibilityArray
60. TSoapTShipmentTypeToShipmentTypeIncompatibilityArray

4. Classes

1. TSoapTLongLatPoint
2. TSoapTLongLatRect
3. TSoapTFontParameters
4. TSoapTPoint
5. TSoapTRect
6. TSoapTObjectPosition
7. TSoapTIconProperties
8. TSoapTGroupSettings
9. TSoapTGroupShapeSettings
10. TSoapTDegeocodeResultEntry
11. TSoapTDegeocodeResult
12. TSoapTDegeocodeCityElementResult
13. TSoapTDegeocodeRoadElementResult
14. TSoapTDegeocodeExResultEntry
15. TSoapTDegeocodeAtPointResult
16. TSoapTDegeocodeAtPointDatabaseResult
17. TSoapTGeocodePointInfo
18. TSoapTGeocodePointInfoEx
19. TSoapTMultiGeocodePointInfoEx
20. TSoapTTiledMapParams
21. TSoapTImageRenderParams
22. TSoapTMapFileEntry
23. TSoapTLocalizeObjectPositionData
24. TSoapTSessionEnumEntry
25. TSoapTViewConfigEntry
26. TSoapTRepositoryRoute
27. TSoapTRouteAttributeParams
28. TSoapTRouteAttributePassedElem
29. TSoapTDriveThrough
30. TSoapTTimeWindow
31. TSoapTShipment
32. TSoapTRouteOptimalizationEntry
33. TSoapTRouteOptimizerResultRoutesEntry
34. TSoapTRouteOptimizerEntry2
35. TSoapTRouteOptimizerEntryAction2
36. TSoapTRouteOptimizerShipmentMove
37. TSoapTRouteOptimizerEntry
38. TSoapTRouteOptimizerShipmentAction
39. TSoapTRouteItinerary
40. TSoapTVehicleParams
41. TSoapTDriverParams
42. TSoapTRoadParams
43. TSoapTRoadViaTollParams
44. TSoapTRoadResults
45. TSoapTViaTollRoadResults
46. TSoapTLogisticTOLLResults
47. TSoapTVehicleEntry
48. TSoapTVehicleCategoryToShipmentTypeIncompatibility
49. TSoapTShipmentTypeToShipmentTypeIncompatibility
50. TSoapCreateSessionID__mcsResult
51. TSoapGetSessionComment__mcsResult
52. TSoapGetSessionLanguageContext__mcsResult
53. TSoapGetMapModules__mcsResult
54. TSoapGetServerVersion__mcsResult
55. TSoapGetMaxSessionsCount__mcsResult
56. TSoapGetCurrentSessionCount__mcsResult
57. TSoapGetSessionLifetimeSeconds__mcsResult
58. TSoapGetActiveSessions__mcsResult
59. TSoapGetProjections__mcsResult
60. TSoapGetAvailableImageFormats__mcsResult
61. TSoapGetDefaultLayers__mcsResult
62. TSoapGetAvailableMapFiles__mcsResult
63. TSoapGetLoadedMapsRegion__mcsResult
64. TSoapGetViewConfigList__mcsResult
65. TSoapGetCurrentViewConfig__mcsResult
66. TSoapAuthGetUserParams__mcsResult
67. TSoapAuthGetUserParamEx__mcsResult
68. TSoapAuthGetUsersList__mcsResult
69. TSoapAuthGetGroup__mcsResult
70. TSoapAuthGetGroupsList__mcsResult
71. TSoapServiceConfigGetServiceParams__mcsResult
72. TSoapRenderMapOnImageByPoint__mcsResult
73. TSoapRenderMapOnImageByRect__mcsResult
74. TSoapRenderSplitMapOnImageByPoint__mcsResult
75. TSoapRenderSplitMapOnImageByRect__mcsResult
76. TSoapRenderMapOnHWNDByPoint__mcsResult
77. TSoapRenderMapOnHWNDByRect__mcsResult
78. TSoapRenderMapOnImageByPointWithCopyright__mcsResult
79. TSoapRenderMapOnImageByRectWithCopyright__mcsResult
80. TSoapRenderSplitMapOnImageByPointWithCopyright__mcsResult
81. TSoapRenderSplitMapOnImageByRectWithCopyright__mcsResult
82. TSoapRenderMapOnHWNDByPointWithCopyright__mcsResult
83. TSoapRenderMapOnHWNDByRectWithCopyright__mcsResult
84. TSoapRenderTiledMap__mcsResult
85. TSoapRenderTiledMapWithCopyright__mcsResult
86. TSoapRenderTiledMapEx__mcsResult
87. TSoapGetTiledMapLayers__mcsResult
88. TSoapConvertMapToScreen__mcsResult
89. TSoapConvertScreenToMap__mcsResult
90. TSoapGetMapPointLength__mcsResult
91. TSoapGetScreenPointLength__mcsResult
92. TSoapInverseCalc__mcsResult
93. TSoapForwardCalc__mcsResult
94. TSoapGetDegeocodeLayers__mcsResult
95. TSoapDegeocodeGetParamValue__mcsResult
96. TSoapDegeocode__mcsResult
97. TSoapDegeocodeEx__mcsResult
98. TSoapDegeocodeExWithAttributes__mcsResult
99. TSoapDegeocodeAtPoint__mcsResult
100. TSoapMapBaseConnect__mcsResult
101. TSoapMapBaseStoreToBlob__mcsResult
102. TSoapGetDatabaseList__mcsResult
103. TSoapGetDatabaseTableList__mcsResult
104. TSoapGetObjectCount__mcsResult
105. TSoapGetObjectFields__mcsResult
106. TSoapGetObject__mcsResult
107. TSoapPostObjects__mcsResult
108. TSoapAppendObject__mcsResult
109. TSoapAppendObjects__mcsResult
110. TSoapDeleteObjects__mcsResult
111. TSoapGetObjectPolygons__mcsResult
112. TSoapGetObjectPolylines__mcsResult
113. TSoapGetObjectEllipses__mcsResult
114. TSoapGetObjectRectangles__mcsResult
115. TSoapGetObjectCircles__mcsResult
116. TSoapGetObjectBinaryData__mcsResult
117. TSoapGetGroupBinaryData__mcsResult
118. TSoapGetGroupSettings__mcsResult
119. TSoapGetGroupShapeSettings__mcsResult
120. TSoapGetVisibleGroups__mcsResult
121. TSoapAppendGroup__mcsResult
122. TSoapGetGroupIcon__mcsResult
123. TSoapAddGroupIcon__mcsResult
124. TSoapGetGroupIcons__mcsResult
125. TSoapCheckUpdate__mcsResult
126. TSoapGetModifiedFields__mcsResult
127. TSoapGetRemovedFields__mcsResult
128. TSoapFilterByText__mcsResult
129. TSoapFilterByPoint__mcsResult
130. TSoapFilterByRadius__mcsResult
131. TSoapFilterByObjectShape__mcsResult
132. TSoapFilterByShape__mcsResult
133. TSoapGetNextResult_FieldSet__mcsResult
134. TSoapGetNextResult_IDSet__mcsResult
135. TSoapGetNextResult_PositionSet__mcsResult
136. TSoapGetNextResult_Set__mcsResult
137. TSoapGetNextResult_UpdatedSet__mcsResult
138. TSoapGetNextResult_RemovedSet__mcsResult
139. TSoapGetObjectAggregates__mcsResult
140. TSoapGetAggregatedObjectShapes__mcsResult
141. TSoapGetAggregatedObjects__mcsResult
142. TSoapSearchGetCountryList__mcsResult
143. TSoapSearchSelectCities__mcsResult
144. TSoapSearchGetCityList__mcsResult
145. TSoapSearchGetCityListEx__mcsResult
146. TSoapSearchGetItemKindList__mcsResult
147. TSoapSearchSelectItems__mcsResult
148. TSoapSearchSelectItemsEx__mcsResult
149. TSoapSearchGetItemsList__mcsResult
150. TSoapSearchAddCityToSelection__mcsResult
151. TSoapSearchAddObjectToSelection__mcsResult
152. TSoapSearchAddStreetWithNumToSelection__mcsResult
153. TSoapSearchGetStreetHandle__mcsResult
154. TSoapSearchAddStreetCrossingToSelection__mcsResult
155. TSoapGeocode__mcsResult
156. TSoapGeocodeEx__mcsResult
157. TSoapMultiGeocodeEx__mcsResult
158. TSoapLocalizeNumFieldsGet__mcsResult
159. TSoapLocalizeNumFieldsGetCount__mcsResult
160. TSoapLocalizeStrFieldsGet__mcsResult
161. TSoapLocalizeStrFieldsGetCount__mcsResult
162. TSoapLocalizeIconGet__mcsResult
163. TSoapLocalizeIconGetCount__mcsResult
164. TSoapLocalizeIconIDToItemIndex__mcsResult
165. TSoapLocalizeObjectPositionGet__mcsResult
166. TSoapLocalizeObjectPositionGetCount__mcsResult
167. TSoapLocalizeObjectGet__mcsResult
168. TSoapLocalizeObjectGetCount__mcsResult
169. TSoapLocalizeObjectEntityIDToItemIndex__mcsResult
170. TSoapLocalizeGetObjectVisibility__mcsResult
171. TSoapGetAvailableIconFormats__mcsResult
172. TSoapRoutePlannerGetAvailableRoadTypes__mcsResult
173. TSoapRoutePlannerSimpleCalculateRoute__mcsResult
174. TSoapRoutePlannerSimpleCalculateRoute2__mcsResult
175. TSoapRoutePlannerSimpleCalculateRoute3__mcsResult
176. TSoapRoutePlannerSimpleCalculateAlternativeRoutesAndStore__mcsResult
177. TSoapRoutePlannerCalculateAlternativeRoutesAndStore__mcsResult
178. TSoapRoutePlannerSimpleCalculateRouteWithBinaryResult__mcsResult
179. TSoapRoutePlannerSimpleCalculateRoute2WithBinaryResult__mcsResult
180. TSoapRoutePlannerSimpleCalculateRoute3WithBinaryResult__mcsResult
181. TSoapRoutePlannerCalculateRoute__mcsResult
182. TSoapRoutePlannerCalculateRouteWithBinaryResult__mcsResult
183. TSoapRoutePlannerGetRouteItinerary__mcsResult
184. TSoapRoutePlannerGetRouteRepresentation__mcsResult
185. TSoapRoutePlannerGetRouteRepresentationWithBinaryResult__mcsResult
186. TSoapRoutePlannerGetRouteSummary__mcsResult
187. TSoapRoutePlannerGetRouteViaTollSummary__mcsResult
188. TSoapRoutePlannerGetRouteLogisticTOLLSummary__mcsResult
189. TSoapRoutePlannerEntriesSet__mcsResult
190. TSoapRoutePlannerEntriesGet__mcsResult
191. TSoapRoutePlannerEntriesGetWithSnapPoints__mcsResult
192. TSoapRoutePlannerEntryAdd__mcsResult
193. TSoapRoutePlannerEntriesAdd__mcsResult
194. TSoapRoutePlannerEntryInsert__mcsResult
195. TSoapRoutePlannerEntryGet__mcsResult
196. TSoapRoutePlannerEntrySet__mcsResult
197. TSoapRoutePlannerEntriesGetCount__mcsResult
198. TSoapRoutePlannerCalculateRoutesWithSingleDepot__mcsResult
199. TSoapRoutePlannerCalculateRoutesWithSingleDepotAndStore__mcsResult
200. TSoapRoutePlannerCalculateRoutesWithMultipleDepots__mcsResult
201. TSoapRoutePlannerCalculateRoutesWithMultipleDepotsAndStore__mcsResult
202. TSoapRoutePlannerCalculateRouteDistanceMatrix__mcsResult
203. TSoapRoutePlannerCalculatePointDistanceFromRoute__mcsResult
204. TSoapRoutePlannerCalculatePointWithinRouteBuffer__mcsResult
205. TSoapRoutePlannerCalculateRouteFromGPSTrack__mcsResult
206. TSoapRoutePlannerVehicleParamsGet__mcsResult
207. TSoapRoutePlannerVehicleParamsGet2__mcsResult
208. TSoapRoutePlannerVehicleParamExGet__mcsResult
209. TSoapRoutePlannerVehicleParamsExGet__mcsResult
210. TSoapRoutePlannerDriverParamsGet__mcsResult
211. TSoapRoutePlannerRoadParamsGet__mcsResult
212. TSoapRoutePlannerRoadViaTollParamsGet__mcsResult
213. TSoapRoutePlannerGetParamValue__mcsResult
214. TSoapRoutePlannerGetParamValues__mcsResult
215. TSoapRoutePlannerRouteStoreToBlob__mcsResult
216. TSoapRouteRepositoryGetRoutesCount__mcsResult
217. TSoapRouteRepositoryGetRoutes__mcsResult
218. TSoapRouteRepositoryGetRouteItinerary__mcsResult
219. TSoapRouteRepositoryGetRouteItineraryByIdent__mcsResult
220. TSoapRouteRepositoryGetRouteRepresentation__mcsResult
221. TSoapRouteRepositoryGetRouteRepresentationByIdent__mcsResult
222. TSoapRouteRepositoryGetRouteSummary__mcsResult
223. TSoapRouteRepositoryGetRouteSummaryByIdent__mcsResult
224. TSoapRouteRepositoryStoreToBlob__mcsResult
225. TSoapRouteRepositoryCalculatePointDistanceFromRoute__mcsResult
226. TSoapRouteAttributesAddPointAttribute__mcsResult
227. TSoapRouteAttributesAddLineAttribute__mcsResult
228. TSoapRouteAttributesAddPolygonAttribute__mcsResult
229. TSoapRouteAttributesAddAlongRouteAttribute__mcsResult
230. TSoapRouteAttributesModifyAlongRouteAttribute__mcsResult
231. TSoapRouteAttributesGetRouteAttribute__mcsResult
232. TSoapRouteAttributesGetRouteAttributeWithGeometry__mcsResult
233. TSoapRouteAttributesGetRouteAttributes__mcsResult
234. TSoapRouteAttributesStoreToBlob__mcsResult
235. TSoapRouteAttributesGetAttributesProviderList__mcsResult
236. TSoapRouteAttributesGetSubscribedProvidersList__mcsResult
237. TSoapRouteAttributesGetDataProviderParams__mcsResult
238. TSoapRouteAttributesGetDataProviderActions__mcsResult
239. TSoapRouteAttributesGetPassedAttributesList__mcsResult
240. TSoapRouteOptimizerSimpleOptimizeRoute__mcsResult
241. TSoapRouteOptimizerOptimizeRoute__mcsResult
242. TSoapRouteOptimizerShipmentTypesGet__mcsResult
243. TSoapRouteOptimizerGetDepotEntry__mcsResult
244. TSoapRouteOptimizerGetEntryTimeWindows__mcsResult
245. TSoapRouteOptimizerGetEntryDeliveryShipments__mcsResult
246. TSoapRouteOptimizerGetEntryPickupShipments__mcsResult
247. TSoapRouteOptimizerGetEntryShipmentDeliveryPickupTimes__mcsResult
248. TSoapRouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet__mcsResult
249. TSoapRouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet__mcsResult
250. TSoapRouteOptimizerSolveProblem__mcsResult
251. TSoapVehicleRepositoryVehicleGet__mcsResult
252. TSoapVehicleRepositoryRoadParamsGet__mcsResult
253. TSoapVehicleRepositoryVehicleViaTollGet__mcsResult
254. TSoapVehicleRepositoryDriverParamsGet__mcsResult
255. TSoapVehicleRepositoryVehiclesGet__mcsResult
256. TSoapSearchGetParamValue__mcsResult
257. TSoapSearchGetParamValues__mcsResult

5. Errors
   1. OperationSuccessful (1)
   2. GeneralError (-1)
   3. FunctionUnimplemented (-2)
   4. SessionNotFound (-3)
   5. NonauthorizedAccess (-4)
   6. NotEnoughPermission (-5)
   7. SessionLimitExceeded (-10)
   8. UserSessionLimitExceeded (-11)
   9. WrongAuthentication (-13)
   10. ReferentialIntegrityError (-6)
   11. UniqueIndexViolation (-7)
   12. DataNotFound (-8)
   13. UpdateRequired (-9)
   14. DatabaseBlocked (-12)
   15. GeneralSearchError (-100)
   16. InvalidCountryIndex (-101)
   17. InvalidCityIndex (-102)
   18. InvalidCityCount (-103)
   19. InvalidItemKindIndex (-104)
   20. InvalidItemCount (-105)
   21. InvalidItemIndex (-106)
   22. StreetRequired (-107)
   23. SearchContextNotInitialized (-108)
   24. InvalidItemHandle (-109)
   25. NumerationNotFound (-110)
   26. CrossingNotFound (-111)
   27. GeneralLocalizeError (-200)
   28. InvalidLocalizeDataIndex (-201)
   29. InvalidIcon (-202)
   30. InvalidLocalizeEntityID (-203)
   31. InvalidNumericFieldsCount (-204)
   32. InvalidStringFieldsCount (-205)
   33. DuplicatedLocalizeEntityID (-206)
   34. InvalidIconMIMEType (-207)
   35. InvalidItemsCount (-208)
   36. InvalidIconData (-209)
   37. GeneralMapFileError (-300)
   38. MapFileNotFound (-301)
   39. MapFileAlreadyOpened (-302)
   40. MapFileAlreadyClosed (-303)
   41. WrongFileFormat (-304)
   42. GeneralRenderingError (-400)
   43. InvalidHDCHandle (-401)
   44. InvalidImageSize (-402)
   45. InvalidImageMIMEType (-403)
   46. WrongImageSize (-404)
   47. GeneralAuthorizationError (-500)
   48. UserAlreadyExists (-501)
   49. UserDoesNotExist (-502)
   50. UserGroupAlreadyExists (-503)
   51. UserGroupDoesNotExist (-504)
   52. UserGroupReadOnly (-505)
   53. GeneralRoutePlannerError (-600)
   54. WrongParamValue (-601)
   55. WrongParamName (-602)
   56. InvalidEntryIndex (-603)
   57. NotEnoughRouteEntries (-604)
   58. RouteNotFound (-605)
   59. DuplicatedEntryIndex (-606)
   60. RouteNotCalculated (-607)
   61. RouteIdentifierNotFound (-608)
   62. DuplicatedRoutingDifficultyIdentifier (-630)
   63. RoutingDifficultyIdentifierNotFound (-631)
   64. VehicleCategoryAlreadyExists (-660)
   65. DepotEntryNotSet (-661)
   66. DuplicatedShipmentIdentifier (-662)

### BaseModule

MapCenter is a multiaccessible map server working in client-server architecture in compatibility with WebServices technology. Client applications communicate with the server by way of WebServices application programming interface using SOAP (Simple Object Access Protocol) and HTTP protocols. Specification of MapCenter's interface in WSDL (Web Services Description Language) format is available via [MapCenterURL:Port]/wsdl/IMapCenterService (Port is 6090 by default). For backward compatibility with older versions communication using XML files over HTTP protocol is supported at [MapCenterURL:Port]/xml?version=1.0 or simplier at [MapCenterURL:Port]. Functions supported by WebServices interface are also available in form of XML files at [MapCenterURL:Port]/xml?version=2.0 . All binary parameters (blobs) in functions supported by XML interface should be Base64 encoded and placed in CDATA section. The binary results of them are just like that encoded.

Communication with MapCenter can be optionally authorized (it is not by default and may be enabled using configaration tool). Standard HTTP authorization is used for it. MapCenter has its own user database. Users are grouped into user groups. One user belongs to one or more groups. At the installation MapCenter contains three users: admin (belonging to following groups: admins, dbadmins, dbeditors, mapviewers), user (dbeditors, mapviewers) and viewer (mapviewers). Each of the three default users has a the same password as his name. Lists of available users and groups can be obtained by AuthGetUsersList and AuthGetGroupsList functions. User database can be managed usig following functions: AuthCreateUser, AuthGetUserParams, AuthGetUserParamEx, AuthSetUserParamEx, AuthModifyUser, AuthModifyUserPassword, AuthDeleteUser, AuthCreateGroup, AuthGetGroup, AuthModifyGroup, AuthDeleteGroup. All the functions require MapCenter authorization enabled and can be invoked only by users belonging to admins group.

MapCenter server generates geographic informations based on vector maps in WGS84 coordinates system. Server offers map images and many additional informations concerned with them. MapCenter functionality is divided into modules. A list of modules available in the instance of server used can be obtained by GetMapModules function.

Each client application may set its own map settings and add its own informations onto maps by way of server sessions. At the beginning of communiction with MapCenter, an application should create such session using CreateSessionID function. Each user (if authorization is enabled) can create one or more sessions. Most of server API functions require the session identifier to be given. Sessions are kept alive by server for some time since last request - this time may be obtained using GetSessionLifetimeSeconds function. To lenghten session's live KeepSession function may be helpful. Early created session can be removed immediatelly by DropSession function. Maximum number of concurrently working sessions may be constrained by the MapCenter lincence - function GetMaxSessionsCount returns the limit. Other functions (GetCurrentSessionCount and GetActiveSessions) return data concerning active sessions - user from admins group can view all sessions, but other users see only their sessions. Admins can destroy any session using AdminDropSession function.

Base module of MapCenter server offers also functionality of loading and activating map files delivered (GetAvailableMapFiles, GetLoadedMapsRegion, ReloadMapFiles, ActivateMapFile, DeactivateMapFile). If MapCenter authorization is enabled, only users belonging to admins group can use these functions. Many maps can be processed simultaneously.

### MapModule

Map module of MapCenter server offers functions for rendering maps as images (bitmaps or semi-vector files). Supported image formats are returned by GetAvailableImageFormats function, and available geographic projections by GetProjections function.

Single map images are generated by RenderMapOnImageByPoint or RenderMapOnImageByRect function. Map can be split into a matrix of images using RenderSplitMapOnImageByPoint or RenderSplitMapOnImageByRect function. For apllications installed on the same machine as MapCenter server more efficient are functions rendering maps on control canvas (HDC) directly - RenderMapOnHWNDByPoint or RenderMapOnHWNDByRect. RenderTiledMap function is optimized for web applications. It serves normalized maps with fixed zooms allowing efficient caching. All the functions are their twin functions which additionally return copyright clauses of supported map providers. There are functions with ...WithCopyright suffix.

Map module of MapCenter server offers also functionality of converting bitmap to geographic coordinates (ConvertScreenToMap) and vice versa (ConvertMapToScreen), calculating distances between points (GetMapPointLength, GetScreenPointLength, InverseCalc, ForwardCalc) and obtaining geographic informations concerning map points (Degeocode, DegeocodeEx, DegeocodeAtPoint).

### SearchModule

Search module of MapCenter server offers functions for searching the maps and address geocoding. Currently searched data is kept into a server session within session search context. The context must be initialized by calling SearchInitialize function.

Map objects beeing searched are grouped into hierarchy - countries contain cities or final map items (roads, airports, rivers, etc.), cities contain final map items. Cities can be found using SearchSelectCities function returning the number of cities found. Required subset of values, stored in the session search context, is accessible by SearchGetCityList or SearchGetCityListEx function. Final map items can be found using SearchSelectItems (searching in cities) or SearchSelectItemsEx (searching in countries) function returning the number of items found. Required subset of values, stored in the session search context, is accessible by SearchGetItemsList function. Each map object may be marked out while map rendering. To add it to the session server context selection one should call one of following functions: SearchAddCityToSelection, SearchAddObjectToSelection, SearchAddStreetWithNumToSelection, SearchAddStreetCrossingToSelection.

Address geocoding is served by Geocode function which returns only one best result for each given address, and GeocodeEx or MultiGeocodeEx functions which return multiple proposals for one given address.

### LocalizeModule

Localize module of MapCenter server offers functions for putting application objects equipped with geographic coordinates onto maps. Each localized object can contain many map positions (points) forming a path (track) or a set of single points. Each point (object position) can be marked out on rendered maps with icon or a circle. Currently localized data is kept into a server session.

All global configuration settings of localization are stored in three collections. List of required additional features of localized objects is divided into numeric fields collection and string fields collection; icons are stored in the third collection. The numeric fields collection is maintained with following functions: LocalizeNumFieldsAdd, LocalizeNumFieldsSet, LocalizeNumFieldsGet, LocalizeNumFieldsRemove, LocalizeNumFieldsClear, LocalizeNumFieldsGetCount. The string fields collection is maintained with following functions: LocalizeStrFieldsAdd, LocalizeStrFieldsSet, LocalizeStrFieldsGet, LocalizeStrFieldsRemove, LocalizeStrFieldsClear, LocalizeStrFieldsGetCount. The icons collection is maintained with following functions: LocalizeIconAdd, LocalizeIconSet, LocalizeIconGet, LocalizeIconRemove, LocalizeIconClear, LocalizeIconGetCount.

Collection of localized objects is maintained with functions: LocalizeObjectAdd, LocalizeObjectSet, LocalizeObjectGet, LocalizeObjectRemove, LocalizeObjectClear, LocalizeObjectGetCount. Adding at least one position for an object is necessary for showing the object on maps. Objects positions are maintained with following functions: LocalizeAddObjectPositions, LocalizeObjectPositionAdd, LocalizeObjectPositionSet, LocalizeObjectPositionGet, LocalizeObjectPositionRemove, LocalizeObjectPositionClear, LocalizeObjectPositionGetCount. It is possible to add to the server session an object together with its positions using one function (LocalizeObjectAddWithPositions). Putting a localized object onto maps while map image rendering can be enabled or disabled by LocalizeSetObjectVisibility function. Current visibility settings are accessible by LocalizeGetObjectVisibility function. Objects localized on maps are recognized by DegeocodeAtPoint function and some features of these objects are returned by the function.

### ObjectsModule

Objects module of MapCenter server (MapBase) offers functions for connecting to a database and putting icons of records from the database (called objects) equipped with geographic coordinates onto maps, searching them using spatial queries and getting properties of them (object fields). Currently MapCenter suports only databases in its internal format (RSDB) - object sets accessible for MapCenter clients are stored as files in subfolder Rsdb and are of two types: Objects (*.emd files) and Logistics (*.eld files). Working with the functions of the module is possible only by authorized access which should be enabled using the configuration tool (disabled by default). Users from dbadmins group can create, restructure, edit and view databases, dbeditors edit and view data, and mapviewers can only view.

Accessible databases and their tables may be obtained using GetDatabaseList and GetDatabaseTableList functions. Server session can be connected to only one database of each type at the same time. Connection is realized by MapBaseConnect function. For closing the connection MapBaseDisconnect function should be used. Alternativelly there is possibility to load an ad hoc database directly from client application using MapBaseLoadFromBlob function and then to save changes as a file by MapBaseStoreToBlob function. New database can be created on server by CreateObjectSet function.

Record count in the object set is returned by GetObjectCount function. Objects are grouped into object groups, determining visual settings of contained objects. Each object can be placed on maps as a point and additionally can have got one or more spatial shapes assigned to it (polygons, polylines, rectangles, ellipese and circles). Any arbitrary binary data can be also assigned to an object. To obtain object set structure (field list, field feateures, object group list, object group icons) GetObjectFields function should be called. The structure of a database may be changed by function SetObjectFields call. Functions GetGroupSettings, GetGroupShapeSettings, GetGroupIcon and GetGroupIcons offer information on an object group visual settings. The modification of group settings is possible using following functions: EditGroup, PostGroup, AppendGroup, DeleteGroup, CancelEditGroup, AddGroupIcon, DeleteGroupIcon. Directly after object set openinig, all object groups are enabled (their objects are drawn on maps, unless object group settings limit icon visibility to some altitude range). The server session disables (or enables again) some object groups using GetVisibleGroups and SetVisibleGroups functions.

Data of objects can be downloaded from server in form of packages containing required number of objects (records) or in form of single object. The data can be get using following functions: GetNextResult_IDSet, GetNextResult_FieldSet, GetNextResult_PositionSet, GetNextResult_Set, GetObject, GetObjectPolygons, GetObjectPolylines, GetObjectRectangles, GetObjectEllipses, GetObjectCircles, GetObjectBinaryData. The modification of objects is possible using following functions: EditObject, PostObject, PostObjects, AppendObject, AppendObjects, DeleteObject, DeleteObjects, CancelEditObject, AppendObjectPolygon, AppendObjectPolyline, AppendObjectRectangle, AppendObjectEllipse, AppendObjectCircle, DeleteObjectShape, SetObjectBinaryData.

Statistic information about data changed by other parallel users can be received by functions: CheckUpdate, GetModifiedFields, GetRemovedFields, GetNextResult_UpdatedSet, GetNextResult_RemovedSet.

Some numerical and spatial aggregations for objects can be obtained using functions GetObjectAggregates, GetAggregatedObjects, GetAggregatedObjectShapes. Objects may be filtered by following functions: FilterByText, FilterByPoint, FilterByRadius, FilterByObjectShape, FilterByShape, SetObjectIDs. Each filter function works on data currently available in the object set - beeing the result of other previous filters. Filters can be disabled by ClearSetFilter function. Filters of currently opened object set are kept into a server session.

### RoutePlannerModule

RoutePlanner module of MapCenter server offers functions for route calculating. Each server session stores a set of parameters taking into account while route calculating: vehicle parameters, driver parameters and road parameters. The parameters can be maintained by following functions: RoutePlannerVehicleParamsGet, RoutePlannerVehicleParamsSet, RoutePlannerVehicleParamsGet2, RoutePlannerVehicleParamsSet2, RoutePlannerDriverParamsGet, RoutePlannerDriverParamsSet, RoutePlannerRoadParamsGet, RoutePlannerRoadParamsSet, RoutePlannerRoadViaTollParamsGet, RoutePlannerRoadViaTollParamsSet. If not explicitly set, the parameters have some default values.

There is also possibility to store in the session more than one vehicle with its own independent parameters. The vehicle repository can be maintained by following functions: VehicleRepositoryAddVehicle, VehicleRepositoryRemoveVehicle, VehicleRepositoryVehicleGet, VehicleRepositoryVehicleSet, VehicleRepositoryVehiclesGet, VehicleRepositoryVehiclesSet, VehicleRepositoryVehiclesClear, VehicleRepositoryRoadParamsGet, VehicleRepositoryRoadParamsSet, VehicleRepositoryVehicleViaTollGet, VehicleRepositoryVehicleViaTollSet. Each vehicle can be fetched from the repository and set as a current session vehicle by VehicleRepositoryVehicleFetch function and replaced using session parameters by VehicleRepositoryVehicleReplace function.

Functions RoutePlannerCalculateRoute or RoutePlannerCalculateRouteWithBinaryResult calculate a route between at least two waypoints (route entries) stored in the sesssion. Calculated route can be removed from the session by RoutePlannerRouteClear function. A list of waypoints is maintained by following functions: RoutePlannerEntriesGet, RoutePlannerEntriesSet, RoutePlannerEntriesSetWithDescription, RoutePlannerEntryAdd, RoutePlannerEntryAddWithDescription, RoutePlannerEntryInsert, RoutePlannerEntryInsertWithDescription, RoutePlannerEntryMove, RoutePlannerEntryComplexMove, RoutePlannerEntryRemove, RoutePlannerEntrySet, RoutePlannerEntrySetWithDescription, RoutePlannerEntriesSetAsDriveThrough, RoutePlannerEntryReverse, RoutePlannerEntriesClear. After calculating the route can be stored in the session. Functions RoutePlannerGetRouteItinerary, RoutePlannerGetRouteRepresentation, RoutePlannerGetRouteRepresentationWithBinaryResult, RoutePlannerGetRouteSummary, RoutePlannerGetRouteViaTollSummary and RoutePlannerGetRouteLogisticTOLLSummary return features of currently stored in the session route.

Function RoutePlannerSimpleCalculateRoute calculates a route using its own parameters and waypoint list which optionally can replace session settings (alternatives are: RoutePlannerSimpleCalculateRouteWithBinaryResult, RoutePlannerSimpleCalculate2, RoutePlannerSimpleCalculateRoute2WithBinaryResult, RoutePlannerSimpleCalculate3, RoutePlannerSimpleCalculateRoute3WithBinaryResult). Function RoutePlannerCalculateRouteDistanceMatrix calculates a set of many routes between many waypoints as start and end points. Function RoutePlannerCalculateRouteFromGPSTrack calculates a route for a given list of waypoints given as a GPS track - it tries to recognize the real route based on the GPS track.

A list of waypoints and a route stored in the session are drawn on maps requested for the session. Visual parameters of routing data and routing options are maintained by functions RoutePlannerGetParamValue, RoutePlannerGetParamValues and RoutePlannerSetParamValue.

Functions RoutePlannerCalculatePointDistanceFromRoute and RoutePlannerCalculatePointWithinRouteBuffer operate on a route calculated and stored in the server session and calculate placement and distances for some given points near by the route.

Functions RoutePlannerCalculateRoutesWithSingleDepot and RoutePlannerCalculateRoutesWithMultipleDepots can calculate many routes at one time. The first function calculates a set of routes beginning with common start point (depot). Each destination point is taken as an end point for subsequent route. The second calculates a set of routes beginning with given start points (depots). Each destination point is taken as an end point for subsequent route beginning with the nearest start point.

RoutePlannerRouteStoreToBlob function generates binary dump of a route (together with route calculating parameters) stored in the server session which can be loaded later by RoutePlannerRouteLoadFromBlob function.

### RouteRepositoryModule

RouteRepository module of MapCenter server offers functions for storing and presenting more than one route in the server session. The module augments functionality of RoutePlanner module. After route calculating, using one of RoutePlanner functions, one can add the route to the repository by RouteRepositoryAddRoute or RouteRepositoryAddRouteWithIdent function. Each route stored in the repository has some properties, i.e. identifier, color, visibility. Identifier is optional, color is set to green, and visibility to true, by default. Current paramaters of routes stored in the repository are available by RouteRepositoryGetRoutes function. The repository can be managed using following functions: RouteRepositoryReplaceRoute, RouteRepositoryReplaceRouteWithIdent, RouteRepositoryRemove, RouteRepositoryRemoveWithIdent, RouteRepositorySetRouteColor, RouteRepositorySetRouteColorByIdent, RouteRepositorySetRouteVisibility, RouteRepositorySetRouteVisibilityByIdent, RouteRepositorySetRouteDescription, RouteRepositorySetRouteDescriptionByIdent, RouteRepositoryClear. Each route can be fetched from repository and set as a current session route by RouteRepositoryFetchRoute or RouteRepositoryFetchRouteWithIdent function. Calculated results of each route are obtained by following functions: RouteRepositoryGetRouteItinerary, RouteRepositoryGetRouteItineraryByIdent, RouteRepositoryGetRouteRepresentation, RouteRepositoryGetRouteRepresentationByIdent, RouteRepositoryGetRouteSummary, RouteRepositoryGetRouteSummaryByIdent.

Functions RoutePlannerCalculateRoutesWithSingleDepotAndStore and RoutePlannerCalculateRoutesWithMultipleDepotsAndStore do the same as corresponding RoutePlannerCalculateRoutesWithSingleDepot and RoutePlannerCalculateRoutesWithMultipleDepots functions. In addition they can store calculated routes in the route repository. Function RouteRepositoryCalculatePointDistanceFromRoute calculates distances for some given points from all routes stored in the server session. Functions RoutePlannerSimpleCalculateAlternativeRoutesAndStore and RoutePlannerCalculateAlternativeRoutesAndStore calculate the optimal route and optionally at most two additional alternative routes. They also can store the resultant routes in the route repository.

RouteRepositoryStoreToBlob function generates binary dump of the whole repository which can be loaded later by RouteRepositoryLoadFromBlob function.

### RouteAttributesModule

RouteAttributes module of MapCenter server offers functions for managing of routing difficulties in the server session beeing taken into account while route calculating. The module augments functionality of RoutePlanner module. Each routing difficulty has its geographic form dependent on its geometry kind (point, polyline, road-along placed polyline or polygon) and other properties, such as unique identifier (for management purposes) maximum speed, maximum vehicle height, additional passing through cost, etc. Difficulties can be add to the server session by RouteAttributesAddPointAttribute, RouteAttributesAddLineAttribute, RouteAttributesAddPolygonAttribute or RouteAttributesAddAlongRouteAttribute function. Current paramaters of routing difficulties stored in the session are available by RouteAttributesGetRouteAttributes, RouteAttributesGetRouteAttribute or RouteAttributesGetRouteAttributeWithGeometry function. Routing difficulties can be managed using following functions: RouteAttributesModifyPointAttribute, RouteAttributesModifyLineAttribute, RouteAttributesModifyPolygonAttribute, RouteAttributesModifyAlongRouteAttribute, RouteAttributesSetRouteAttribute, RouteAttributesDeleteRouteAttribute, RouteAttributesClearRouteAttribute.

In addition route planner can take into account difficulties received from other external sources (providers). Functions RouteAttributesSubscribeToDataProvider and RouteAttributesUnsubscribeFromDataProvider allow managing of the sources supported (available list can be get using RouteAttributesGetAttributesProviderList function).

RouteAttributesStoreToBlob function generates binary dump of all session routing difficulties which can be loaded later by RouteAttributesLoadFromBlob function.

For analyze purposes RouteAttributesGetPassedAttributesList function may be useful.

### RouteOptimizerModule

RouteOptimizer module of MapCenter server offers functions of two kinds - basic and extended. Basic set of functions offers only route waypoint sequence optimization but extended functions are capable of solving optimal shipment delivery plans for a set of defined vehicle kinds. There are two modes of the optimization - the first takes into account only straight distances between waypoints, but the second default method (switching parameter routeoptimizerparams.calcinterpointlengths by use of function RoutePlannerSetParamValue) calculates all distances on roads. The second method is much slower and is performed with a set of parameters taking into account while route calculating: vehicle parameters, driver parameters and road parameters. The parameters can be maintained by following RoutePlanner module functions: RoutePlannerVehicleParamsGet2, RoutePlannerVehicleParamsSet2, RoutePlannerDriverParamsGet, RoutePlannerDriverParamsSet, RoutePlannerRoadParamsGet, RoutePlannerRoadParamsSet. If not explicitly set, the parameters have some default values.

Basic functions are RouteOptimizerOptimizeRoute and RouteOptimizerSimpleOptimizeRoute. Function RouteOptimizerOptimizeRoute works on at least two waypoints (route entries) stored in the sesssion. A list of waypoints is maintained by following functions: RoutePlannerEntriesGet, RoutePlannerEntriesSet, RoutePlannerEntriesSetWithDescription, RoutePlannerEntryAdd, RoutePlannerEntryAddWithDescription, RoutePlannerEntryInsert, RoutePlannerEntryInsertWithDescription, RoutePlannerEntryMove, RoutePlannerEntryComplexMove, RoutePlannerEntryRemove, RoutePlannerEntrySet, RoutePlannerEntrySetWithDescription, RoutePlannerEntryReverse, RoutePlannerEntriesClear. After calculating the route can be stored in the session. Function RouteOptimizerSimpleOptimizeRoute optimizes a route using its own parameters and waypoint list which optionally can replace session settings.

Extended version of the module has one main function RouteOptimizerSolveProblem. It takes into account the list of waypoints stored in the server session as described above, but waypoints can be augmented with additional properties by marking one of them as a depot point (functions RouteOptimizerSetDepotEntry and RouteOptimizerGetDepotEntry) and assigning to them delivery time windows and delivery shipment data and times (functions RouteOptimizerGetEntryTimeWindows, RouteOptimizerClearEntryTimeWindows, RouteOptimizerAddEntryTimeWindow, RouteOptimizerAddEntryTimeWindows, RouteOptimizerSetEntryTimeWindows, RouteOptimizerGetEntryDeliveryShipments, RouteOptimizerAddEntryDeliveryShipment, RouteOptimizerAddEntryDeliveryShipments, RouteOptimizerClearEntryDeliveryShipments, RouteOptimizerSetEntryDeliveryShipments, RouteOptimizerGetEntryShipmentDeliveryPickupTimes, RouteOptimizerSetEntryShipmentDeliveryPickupTimes). The function generates a set of routes dividing optimally the set of waypoints and assigning them to vehicles defined using following functions: VehicleRepositoryAddVehicle, VehicleRepositoryRemoveVehicle, VehicleRepositoryVehicleGet, VehicleRepositoryVehicleSet, VehicleRepositoryVehiclesGet, VehicleRepositoryVehiclesSet, VehicleRepositoryVehiclesClear, VehicleRepositoryRoadParamsGet, VehicleRepositoryRoadParamsSet, VehicleRepositoryDriverParamsGet, VehicleRepositoryDriverParamsSet, VehicleRepositoryVehicleViaTollGet, VehicleRepositoryVehicleViaTollSet. There is also posibility to set some incompatibilities between shipments and vehicles (functions RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet).

### ActivateMapFile function.

Activates map file identified by FileName. The file must be one of loaded map files.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### FileName

Name of the map file.

Type: WideString

### AddGroupIcon function.

Adds new icon to the object set.

Module: ObjectsModule

Result type: TSoapAddGroupIcon__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

#### GroupIcon

Icon transferred as a byte stream.

Type: TByteDynArray

#### GroupIconProperties

Icon properties.

Type: TSoapTIconProperties

### AdminDropSession function.

Removes given session with all its data. Administrative rights are required.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: WideString

#### SessionIP

IP address of client application, which is owner of the session.

Type: WideString

#### SessionUserName

Name of user assigned to session.

Type: WideString

### AppendGroup function.

Inserts new object group to the object set.

Module: ObjectsModule

Result type: TSoapAppendGroup__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupSettings

Visual settings of the object group.

Type: TSoapTGroupSettings

#### VisibleFields

Names of fields essential for the object group - other fields in object set are not important for the object group.

Type: TWideStringArray

### AppendObject function.

Inserts new object to the object set.

Module: ObjectsModule

Result type: TSoapAppendObject__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

#### FieldNames

Names of object fields to be set. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

#### FieldValues

Values for corresponding object fields.

Type: TWideStringArray

#### ObjectPosition

Object geographic data.

Type: TSoapTObjectPosition

#### CaptionPosition

Position of object name being drawn on maps nearby its icon. It is the alignment of object name with reference to its icon. Supported values are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07

Type: TCaptionPosition

### AppendObjectCircle function.

Inserts new or overwrites existing circle within a shape list tied with object identified by given ID. The object will be locked after the call.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### MapPoint

Geographical coordinates of middle point.

Type: TSoapTLongLatPoint

#### MapRadius

Circle radius in meters.

Type: Double

#### ShapeID

Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.

Type: Integer

### AppendObjectEllipse function.

Inserts new or overwrites existing ellipse within a shape list tied with object identified by given ID. The object will be locked after the call.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### MapRect

Geographical coordinates of a bounding rectangle of ellipse.

Type: TSoapTLongLatRect

#### ShapeID

Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.

Type: Integer

### AppendObjectPolygon function.

Inserts new or overwrites existing polygon within a shape list tied with object identified by given ID. The object will be locked after the call.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### MapPoints

Geographical coordinates for vertices of the polygon.

Type: TSoapTLongLatPointArray

#### ShapeID

Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.

Type: Integer

### AppendObjectPolyline function.

Inserts new or overwrites existing polyline within a shape list tied with object identified by given ID. The object will be locked after the call.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### MapPoints

Geographical coordinates for vertices of the polyline.

Type: TSoapTLongLatPointArray

#### ShapeID

Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.

Type: Integer

### AppendObjectRectangle function.

Inserts new or overwrites existing rectangle within a shape list tied with object identified by given ID. The object will be locked after the call.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### MapRect

Geographical coordinates of rectangle.

Type: TSoapTLongLatRect

#### ShapeID

Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.

Type: Integer

### AppendObjects function.

Inserts a set of new objects to the object set.

Module: ObjectsModule

Result type: TSoapAppendObjects__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupIDs

Object group identifiers.

Type: TWideStringArray

#### FieldNames

Names of object fields to be set. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

#### FieldValues

Values for corresponding objects and their fields.

Type: TSoapTWideStringArrayArray

#### ObjectPosition

A list of object geographic datas.

Type: TSoapTObjectPositionArray

#### CaptionPosition

A list of positions of object name being drawn on maps nearby its icon. It is the alignment of object name with reference to its icon. Supported values are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07

Type: TCaptionPositionArray

### AuthCreateGroup function.

Adds user group.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### GroupName

User group name.

Type: WideString

#### GroupComment

User group comment.

Type: WideString

### AuthCreateUser function.

Adds user account.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### Username

Username.

Type: WideString

#### Password

Password.

Type: WideString

#### Comment

Comment.

Type: WideString

#### AccountEnabled

Option of account enabling.

Type: Boolean

#### Groups

A list of user groups the account belongs to.

Type: TWideStringArray

### AuthDeleteGroup function.

Removes user group.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### GroupName

User group name.

Type: WideString

### AuthDeleteUser function.

Removes user's account.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### Username

Username.

Type: WideString

### AuthGetGroup function.

Returns user group comment.

Module: BaseModule

Result type: TSoapAuthGetGroup__mcsResult

Parameters:

#### GroupName

User group name.

Type: WideString

### AuthGetGroupsList function.

Returns a list of user groups.

Module: BaseModule

Result type: TSoapAuthGetGroupsList__mcsResult

### AuthGetUserParamEx function.

Returns a value of user's additional parameter.

Module: BaseModule

Result type: TSoapAuthGetUserParamEx__mcsResult

Parameters:

#### Username

Username.

Type: WideString

#### ParamName

Parameter name.

Type: WideString

### AuthGetUserParams function.

Returns user's properties.

Module: BaseModule

Result type: TSoapAuthGetUserParams__mcsResult

Parameters:

#### Username

Username.

Type: WideString

### AuthGetUsersList function.

Returns a list of server users.

Module: BaseModule

Result type: TSoapAuthGetUsersList__mcsResult

### AuthModifyGroup function.

Modifies user group properties.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### GroupName

User group name.

Type: WideString

#### GroupComment

User group comment.

Type: WideString

### AuthModifyUser function.

Modifies user's account.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### Username

Username.

Type: WideString

#### Comment

Comment.

Type: WideString

#### AccountEnabled

Option of account enabling.

Type: Boolean

#### Groups

A list of user groups the account belongs to.

Type: TWideStringArray

### AuthModifyUserPassword function.

Modifies user's password.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### Username

Username.

Type: WideString

#### Password

New password.

Type: WideString

### AuthSetUserParamEx function.

Sets a value for user's additional parameter. If the parameter does not exist, it will be created.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### Username

Username.

Type: WideString

#### ParamName

Parameter name.

Type: WideString

#### ParamValue

Parameter value.

Type: WideString

### CancelEditGroup function.

Unlocks object group identified by given ID.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

### CancelEditObject function.

Unlocks object identified by given ID.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

### CancelEditObjectFields function.

Unlocks the currently opened object set locked by EditObjectFields function (requires administrative privileges).
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### CheckUpdate function.

Returns a statistic information about data changed by other users since last call of that function.

Module: ObjectsModule

Result type: TSoapCheckUpdate__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

### ClearMapSelection function.

Removes all session selections, i.e. selections of found map elements.
Returns value from error code table.

Module: SearchModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### ClearSetFilter function.

Disables all filters performed on the object set by the server session. All objects are available from now.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

### ConvertMapToScreen function.

Converts geographic coordinates to screen coordinates (image pixels).

Module: MapModule

Result type: TSoapConvertMapToScreen__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

The geographic middle point of a map presented on the image.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of the image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of the image. It must be positive value.

Type: Integer

#### ImageRenderParams

Other parameters of the image.

Type: TSoapTImageRenderParams

#### MapPoints

A list of geographic points to be converted.

Type: TSoapTLongLatPointArray

### ConvertScreenToMap function.

Converts screen coordinates (image pixels) to geographic ones.

Module: MapModule

Result type: TSoapConvertScreenToMap__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

The geographic middle point of a map presented on the image.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of the image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of the image. It must be positive value.

Type: Integer

#### ImageRenderParams

Other parameters of the image.

Type: TSoapTImageRenderParams

#### ScreenPoints

A list of screen points to be converted. Their coordinates may be negative or higher than given image sizes.

Type: TSoapTPointsArray

### CreateObjectSet function.

Creates a new object set (requires administrative privileges).
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AConnectionString

Object set parameters transferred as a semicolon separated string in form "Parameter1=Value1;Parameter2=Value2;...". Available parameters are: DBName, UserName, UserPassword. Parameters may be placed in any order.

Type: WideString

#### FieldNames

Names of object fields.

Type: TWideStringArray

#### FieldTypes

New types of corresponding object fields. Following values are supported:
- Character or string field = 0x01
- 16-bit integer field = 0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field = 0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
- Date field = 0x09
- Time field = 0x0A
- Date and time field = 0x0B

Type: TDynamicByteArray

#### FieldSize

Sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.

Type: TDynamicIntegerArray

#### FieldPrecision

Precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.

Type: TDynamicIntegerArray

#### FieldInfo

Parameters of corresponding object fields. It is a bit vector for each field - each bit deals with one parameter:
- key field = 0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
- indexed field = 0x08
- not null field (value required) = 0x10

Type: TDynamicByteArray

#### FieldFunctions

Specific features of corresponding object fields. Following values are supported:
- name (object name being drawn on maps) = 0x01
- city (for geocoding purposes) = 0x02
- street (for geocoding purposes) = 0x03
- number (for geocoding purposes) = 0x04
- postal code (for geocoding purposes) = 0x05
- country (for geocoding purposes) = 0x0F

Type: TDynamicByteArray

#### SaveToDisk

Option of saving new object set to the disk. If false, object set will be volatile - only for current session.

Type: Boolean

### CreateSessionID function.

Creates a new server session.

Module: BaseModule

Result type: TSoapCreateSessionID__mcsResult

### DeactivateMapFile function.

Deactivates map file identified by FileName. The file must be one of loaded map files.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### FileName

Name of the map file.

Type: WideString

### Degeocode function.

Returns (degeocodes) geographic information for a list of given geographic points. An administrative and only the closest urbanistic and topographic information concerning each point is generated.

Module: MapModule

Result type: TSoapDegeocode__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

An orientation point.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of a map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of a map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### MapPoints

The list of points to be degeocoded.

Type: TSoapTLongLatPointArray

#### QueryRadius

Search radius in meters. It must be nonnegative value.

Type: Double

#### DegeocodeLayers

List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.

Type: TWideStringArray

#### OnlyNamedEntries

If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.

Type: Boolean

#### UseViewVisibility

If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.

Type: Boolean

### DegeocodeAtPoint function.

Returns (degeocodes) geographic information for the given geographic point. An information for all given layers maching the given search radius is generated.

Module: MapModule

Result type: TSoapDegeocodeAtPoint__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

An orientation point.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of a map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of a map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### DegeocodePoint

Geographic coordinates of the degeocoded point.

Type: TSoapTLongLatPoint

#### QueryRadius

Search radius in meters. It must be nonnegative value.

Type: Double

#### MaxElems

Maximum number of required resultant elements. It must be nonnegative value, 0 means no limits. Elements of each resultant category are counted independently.

Type: Integer

#### DegeocodeLayers

List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.

Type: TWideStringArray

#### OnlyNamedEntries

If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.

Type: Boolean

#### UseViewVisibility

If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.

Type: Boolean

### DegeocodeEx function.

Returns (degeocodes) geographic information for a list of given geographic points. Only the closest information concerning each point is generated (for all given layers).

Module: MapModule

Result type: TSoapDegeocodeEx__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

An orientation point.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of a map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of a map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### MapPoints

The list of points to be degeocoded.

Type: TSoapTLongLatPointArray

#### QueryRadius

Search radius in meters. It must be nonnegative value.

Type: Double

#### DegeocodeLayers

List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.

Type: TWideStringArray

#### OnlyNamedEntries

If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.

Type: Boolean

#### UseViewVisibility

If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.

Type: Boolean

### DegeocodeExWithAttributes function.

Returns (degeocodes) geographic information for a list of given geographic points. Only the closest information concerning each point is generated (for all given layers). For future use.

Module: MapModule

Result type: TSoapDegeocodeExWithAttributes__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

An orientation point.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of a map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of a map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### MapPoints

The list of points to be degeocoded.

Type: TSoapTLongLatPointArray

#### MapPointAttributes

The list of point's additional attributes.

Type: TWideStringArray

#### QueryRadius

Search radius in meters. It must be nonnegative value.

Type: Double

#### DegeocodeLayers

List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.

Type: TWideStringArray

#### OnlyNamedEntries

If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.

Type: Boolean

#### UseViewVisibility

If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.

Type: Boolean

### DegeocodeGetParamValue function.

Returns a value for given parameter of degeocoding stored in the session. Parameter value meanings:
* degeocodeparams.degeocodetime - time of degeocoding within a day, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on (by default it is 09:00 a.m.)
* degeocodeparams.vehicletype - vehicle type for degeocoding purposes as defined in the TVehicleEntry (default value is 0)

Module: MapModule

Result type: TSoapDegeocodeGetParamValue__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ParamName

Parameter name.

Type: WideString

### DegeocodeSetParamValue function.

Sets a value for given parameter of degeocoding stored in the session.
Returns value from error code table.

Module: MapModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ParamName

Parameter name.

Type: WideString

#### ParamValue

Parameter value.

Type: WideString

### DeleteGroup function.

Removes object group identified by given ID.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

### DeleteGroupIcon function.

Removes an icon from the object set.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

#### IconID

Icon identifier.

Type: Integer

### DeleteObject function.

Removes object identified by given ID.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

### DeleteObjects function.

Rmoves objects identified by given IDs.

Module: ObjectsModule

Result type: TSoapDeleteObjects__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectIDs

Object identifiers.

Type: TWideStringArray

### DeleteObjectShape function.

Removes a shape from the shape list tied with object identified by given ID.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### ShapeID

Shape identifier. Value -1 means all shapes.

Type: Integer

### DropSession function.

Removes the session with all its data.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### EditGroup function.

Locks an object group for changing.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

### EditObject function.

Locks object identified by given ID for changing.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

### EditObjectFields function.

Locks the currently opened object set for restructuring (requires administrative privileges).
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### FilterByObjectShape function.

Filters currently opened object set. Function finds objects placed in or intersected with given object shape stored in the database. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.

Module: ObjectsModule

Result type: TSoapFilterByObjectShape__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### ShapeID

Shape identifier.

Type: Integer

#### Limit

Result limitation.

Type: Integer

### FilterByPoint function.

Filters currently opened object set. Function finds objects that are nearest to the given point. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.

Module: ObjectsModule

Result type: TSoapFilterByPoint__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### MiddlePoint

Geographic coordinates of search middle point.

Type: TSoapTLongLatPoint

#### Limit

Result limitation.

Type: Integer

### FilterByRadius function.

Filters currently opened object set. Function finds objects placed in geographic circle with given middle point and radius. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.

Module: ObjectsModule

Result type: TSoapFilterByRadius__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### MiddlePoint

Geographic coordinates of search middle point.

Type: TSoapTLongLatPoint

#### Radius

Search radius (in meters).

Type: Integer

#### Limit

Result limitation.

Type: Integer

### FilterByShape function.

Filters currently opened object set. Function finds objects placed in or intersected with given object shape. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.

Module: ObjectsModule

Result type: TSoapFilterByShape__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### MapPointArray

Geographical coordinates for vertices of the shape.

Type: TSoapTLongLatPointArray

#### Limit

Result limitation.

Type: Integer

### FilterByText function.

Filters currently opened object set using text or numeric search. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects matching given conditions. Object data may be obtained using GetNextResult_Set function.

Module: ObjectsModule

Result type: TSoapFilterByText__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### FieldNames

Names of condition fields. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

#### FieldValues

Values being searched in condition fields.

Type: TWideStringArray

#### Conditions

Search conditions for corresponding fields. Currently containment condition for text fields and equivalent condition for other fields are supported. In both cases string "=" should be given.

Type: TWideStringArray

#### Limit

Result limitation.

Type: Integer

### ForwardCalc function.

Returns a destination point with given distance from the start point according to the given azimuth.

Module: MapModule

Result type: TSoapForwardCalc__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### StartPoint

Geographic coordinates of the start point.

Type: TSoapTLongLatPoint

#### Length

Distance from the start point.

Type: Double

#### Azimuth

Requested azimuth. It must be an angle in degrees between 0 and 360 counterclockwise.

Type: Double

### Geocode function.

Translates addresses to their geographic coordinates. For each address the function returns the geocode level, too.

Module: SearchModule

Result type: TSoapGeocode__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ASCIISearch

This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).

Type: Boolean

#### Points

A list of addresses to be geocoded.

Type: TSoapTGeocodePointInfoArray

### GeocodeEx function.

Translates an address to its geographic coordinates. More than one result can be proposed. The function returns the address found and its geocode level for each proposal.

Module: SearchModule

Result type: TSoapGeocodeEx__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ASCIISearch

This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).

Type: Boolean

#### Point

An address to be geocoded.

Type: TSoapTGeocodePointInfoEx

#### MaxResultCount

Maximal result count. Function returns at most 100 results, so if the value is greater, length of resultant lists should be checked.

Type: Integer

### GetActiveSessions function.

Return statistic information of all active server sessions.

Module: BaseModule

Result type: TSoapGetActiveSessions__mcsResult

### GetAggregatedObjects function.

Returns identifiers of objects contained in shapes of given objects.

Module: ObjectsModule

Result type: TSoapGetAggregatedObjects__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupIDs

Identifiers of object groups being searched.

Type: TWideStringArray

#### ObjectIDs

Identifiers of given objects.

Type: TWideStringArray

### GetAggregatedObjectShapes function.

Returns identifiers of objects with shapes containing given objects.

Module: ObjectsModule

Result type: TSoapGetAggregatedObjectShapes__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupIDs

Identifiers of object groups being searched.

Type: TWideStringArray

#### ObjectIDs

Identifiers of given objects.

Type: TWideStringArray

### GetAvailableIconFormats function.

Returns a list of icon MIME formats used in localization functions.

Module: MapModule

Result type: TSoapGetAvailableIconFormats__mcsResult

### GetAvailableImageFormats function.

Returns a list of image MIME formats used in functions returning maps as image files.

Module: MapModule

Result type: TSoapGetAvailableImageFormats__mcsResult

### GetAvailableMapFiles function.

Returns a list of all currently loaded map files. When starting server loads all map files (files with extension .eff) from subdirectory DATA of server installation directory.

Module: BaseModule

Result type: TSoapGetAvailableMapFiles__mcsResult

### GetCurrentSessionCount function.

Returns the number of currently processed server sessions.

Module: BaseModule

Result type: TSoapGetCurrentSessionCount__mcsResult

### GetCurrentViewConfig function.

Returns current session view config.

Module: BaseModule

Result type: TSoapGetCurrentViewConfig__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### GetDatabaseList function.

Returns a list of available databases of given type configured on the server.

Module: ObjectsModule

Result type: TSoapGetDatabaseList__mcsResult

Parameters:

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

### GetDatabaseTableList function.

Returns a list of tables (object sets) available for given database type.

Module: ObjectsModule

Result type: TSoapGetDatabaseTableList__mcsResult

Parameters:

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

### GetDefaultLayers function.

Returns a list of all default map layers.

Module: MapModule

Result type: TSoapGetDefaultLayers__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### GetDegeocodeLayers function.

Returns a list of all map layers taking into account by degecode functions.

Module: MapModule

Result type: TSoapGetDegeocodeLayers__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### GetGroupBinaryData function.

Returns a binary data tied with object group identified by given ID.

Module: ObjectsModule

Result type: TSoapGetGroupBinaryData__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

### GetGroupIcon function.

Returns a bitmap being an icon assigned to the object group.

Module: ObjectsModule

Result type: TSoapGetGroupIcon__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

### GetGroupIcons function.

Returns a list of all icons stored in a database.

Module: ObjectsModule

Result type: TSoapGetGroupIcons__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

### GetGroupSettings function.

Returns settings of an object group.

Module: ObjectsModule

Result type: TSoapGetGroupSettings__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

### GetGroupShapeSettings function.

Returns settings of an object group concerning shape visualization.

Module: ObjectsModule

Result type: TSoapGetGroupShapeSettings__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

### GetLoadedMapsRegion function.

Returns geographic coordinates of rectangle bounding a sum of all active map file regions.

Module: BaseModule

Result type: TSoapGetLoadedMapsRegion__mcsResult

### GetMapModules function.

Returns a list of delivered server modules.

Module: BaseModule

Result type: TSoapGetMapModules__mcsResult

### GetMapPointLength function.

Calculates total length in meters of a path composed of given list of geographic points.

Module: MapModule

Result type: TSoapGetMapPointLength__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MapPoints

The list of geographic points forming the path.

Type: TSoapTLongLatPointArray

### GetMaxSessionsCount function.

Returns the maximum number of simultaneously processed server sessions. Returns 0 if the number is not constrained.

Module: BaseModule

Result type: TSoapGetMaxSessionsCount__mcsResult

### GetModifiedFields function.

Returns a list of database fields modified since last call of that function.

Module: ObjectsModule

Result type: TSoapGetModifiedFields__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### GetNextResult_FieldSet function.

Returns values for given object field, for given part of the object set.

Module: ObjectsModule

Result type: TSoapGetNextResult_FieldSet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectIDs

List of identifiers of requested objects.

Type: TWideStringArray

#### FieldName

Name of requested field. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: WideString

### GetNextResult_IDSet function.

Returns object identifiers and identifiers of their groups for the next part of the object set.

Module: ObjectsModule

Result type: TSoapGetNextResult_IDSet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### Limit

Requested object count.

Type: Integer

#### FromBeginning

Option of getting objects from beginning of the object set.

Type: Boolean

### GetNextResult_PositionSet function.

Returns geographic information for given part of the object set.

Module: ObjectsModule

Result type: TSoapGetNextResult_PositionSet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectIDs

List of identifiers of requested objects.

Type: TWideStringArray

### GetNextResult_RemovedSet function.

Returns the next part of the object identifiers removed by other users.

Module: ObjectsModule

Result type: TSoapGetNextResult_RemovedSet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### Limit

Requested object count.

Type: Integer

### GetNextResult_Set function.

Returns the next part of the object set. Values for given object fields, object identifiers and identifiers of their groups and geographic information are returned.

Module: ObjectsModule

Result type: TSoapGetNextResult_Set__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### Limit

Requested object count.

Type: Integer

#### FieldNames

Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

#### FromBeginning

Option of getting objects from beginning of the object set.

Type: Boolean

### GetNextResult_UpdatedSet function.

Returns the next part of the objects updated by other users. Values for given object fields, object identifiers and identifiers of their groups and geographic information are returned.

Module: ObjectsModule

Result type: TSoapGetNextResult_UpdatedSet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### Limit

Requested object count.

Type: Integer

#### FieldNames

Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

### GetObject function.

Returns all properties of an object identified by given ID.

Module: ObjectsModule

Result type: TSoapGetObject__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### FieldNames

Names of object fields to be returned. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

### GetObjectAggregates function.

Returns aggregate values for object fields.

Module: ObjectsModule

Result type: TSoapGetObjectAggregates__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### FieldNames

Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

### GetObjectBinaryData function.

Returns a binary data tied with object identified by given ID.

Module: ObjectsModule

Result type: TSoapGetObjectBinaryData__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

### GetObjectCircles function.

Returns coordinates of circle(s) tied with object identified by given ID.

Module: ObjectsModule

Result type: TSoapGetObjectCircles__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### CircleID

Circle identifier. If less then 0 - all circles of the object will be returned.

Type: Integer

### GetObjectCount function.

Returns a count of objects in a object set.

Module: ObjectsModule

Result type: TSoapGetObjectCount__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

### GetObjectEllipses function.

Returns coordinates of ellipse(s) tied with object identified by given ID.

Module: ObjectsModule

Result type: TSoapGetObjectEllipses__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### EllipseID

Ellipse identifier. If less then 0 - all ellipses of the object will be returned.

Type: Integer

### GetObjectFields function.

Returns a structure of object set currently opened.

Module: ObjectsModule

Result type: TSoapGetObjectFields__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

### GetObjectPolygons function.

Returns coordinates of polygon(s) tied with object identified by given ID.

Module: ObjectsModule

Result type: TSoapGetObjectPolygons__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### PolygonID

Polygon identifier. If less then 0 - all polygons of the object will be returned.

Type: Integer

### GetObjectPolylines function.

Returns coordinates of polyline(s) tied with object identified by given ID.

Module: ObjectsModule

Result type: TSoapGetObjectPolylines__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### PolylineID

Polyline identifier. If less then 0 - all polylines of the object will be returned.

Type: Integer

### GetObjectRectangles function.

Returns coordinates of rectangle(s) tied with object identified by given ID.

Module: ObjectsModule

Result type: TSoapGetObjectRectangles__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### RectangleID

Rectangle identifier. If less then 0 - all rectangles of the object will be returned.

Type: Integer

### GetProjections function.

Returns a list of supported map projections.

Module: MapModule

Result type: TSoapGetProjections__mcsResult

### GetRemovedFields function.

Returns a list of database fields removed since last call of that function.

Module: ObjectsModule

Result type: TSoapGetRemovedFields__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### GetScreenPointLength function.

Calculates total length in meters of a path composed of given list of screen points.

Module: MapModule

Result type: TSoapGetScreenPointLength__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

The geographic middle point of a map presented on the image.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of the image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of the image. It must be positive value.

Type: Integer

#### ImageRenderParams

Other parameters of the image.

Type: TSoapTImageRenderParams

#### ScreenPoints

A list of screen points to be converted. Their coordinates may be negative or higher than given image sizes.

Type: TSoapTPointsArray

### GetServerVersion function.

Returns versions of the server and data components.

Module: BaseModule

Result type: TSoapGetServerVersion__mcsResult

### GetSessionComment function.

Gets session comment.

Module: BaseModule

Result type: TSoapGetSessionComment__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### GetSessionLanguageContext function.

Gets session language context.

Module: BaseModule

Result type: TSoapGetSessionLanguageContext__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ContextIndex

Context level (0-2).

Type: Integer

### GetSessionLifetimeSeconds function.

Returns a time interval (in seconds), which inactive server session is removed after.

Module: BaseModule

Result type: TSoapGetSessionLifetimeSeconds__mcsResult

### GetTiledMapLayers function.

Returns a list of all layers supported by RenderTiledMap function.

Module: MapModule

Result type: TSoapGetTiledMapLayers__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### GetViewConfigList function.

Returns list od current view config files. When starting server loads all map files (files with extension .efc) from subdirectory DATA of server installation directory.

Module: BaseModule

Result type: TSoapGetViewConfigList__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### GetVisibleGroups function.

Returns object group visibility.

Module: ObjectsModule

Result type: TSoapGetVisibleGroups__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

### InverseCalc function.

Calculates a length in meters and azimuths between two geographic poins.

Module: MapModule

Result type: TSoapInverseCalc__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### StartPoint

Geographic coordinates of the start point.

Type: TSoapTLongLatPoint

#### StopPoint

Geographic coordinates of the stop point.

Type: TSoapTLongLatPoint

### KeepSession function.

Enforces keeping the session available.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### SessionID

Identifier of the session to be kept.

Type: TSessionID

### LoadCurrentViewConfig function.

Loads current session view config from blob.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ViewConfigBlob

View config file.

Type: TByteDynArray

### LocalizeAddObjectPositions function.

Adds new positions to the positions collection of the given localized object saved in the server session. The positions are appended at the end of the collection. If the RemovePreviousPositions option is active for the localized object, earlier added positions are removed. New positions are from now displayed on maps rendered for the session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique localized object identifier.

Type: Integer

#### ObjectPositions

A list of positions of the object.

Type: TSoapTLocalizeObjectPositionDataArray

#### StringFields

Values for all string fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).

Type: TSoapTWideStringArrayArray

#### FloatFields

Values for all numeric fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).

Type: TSoapTFloatArrayArray

### LocalizeGetObjectVisibility function.

Returns information about visibility of all localized object in collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeGetObjectVisibility__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeIconAdd function.

Adds a new icon to the icons collection saved in the server session. The icon is appended at the end of the collection.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### IconInfo

Icon properties.

Type: TSoapTIconProperties

#### IconData

An icon transferred as a byte stream.

Type: TByteDynArray

### LocalizeIconClear function.

Removes all icons from the icons collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeIconGet function.

Returns properties of an icon contained in the icons collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeIconGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ItemIndex

Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.

Type: Integer

### LocalizeIconGetCount function.

Returns the number of icons in the icons collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeIconGetCount__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeIconIDToItemIndex function.

Returns an index of an icon in the icons collection saved in the server session - the icon with the given identifier .

Module: LocalizeModule

Result type: TSoapLocalizeIconIDToItemIndex__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### IconId

A unique icon identifier.

Type: Integer

### LocalizeIconRemove function.

Removes an icon from the icons collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ItemIndex

Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.

Type: Integer

### LocalizeIconSet function.

Changes properties of an icon contained in the icons collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ItemIndex

Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.

Type: Integer

#### IconInfo

Icon properties.

Type: TSoapTIconProperties

#### IconData

An icon transferred as a byte stream.

Type: TByteDynArray

### LocalizeNumFieldsAdd function.

Adds a new field to the numeric fields collection saved in the server session. The field is appended at the end of the collection.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Name

Field name.

Type: WideString

#### ShowOnInfo

Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.

Type: Boolean

### LocalizeNumFieldsClear function.

Removes all fields from the numeric fields collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeNumFieldsGet function.

Returns properties of a field contained in the numeric fields collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeNumFieldsGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.

Type: Integer

### LocalizeNumFieldsGetCount function.

Returns the number of fields in the numeric fields collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeNumFieldsGetCount__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeNumFieldsRemove function.

Removes a field from the numeric fields collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.

Type: Integer

### LocalizeNumFieldsSet function.

Changes properties of a field contained in the numeric fields collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.

Type: Integer

#### Name

Field name.

Type: WideString

#### ShowOnInfo

Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.

Type: Boolean

### LocalizeObjectAdd function.

Adds a new object to the localized objects collection saved in the server session. The object is appended at the end of the collection.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique object identifier.

Type: Integer

#### Name

Object name displayed by the last position of an object on the map, providing the ShowName option is active.

Type: WideString

#### ShowName

Information on whether to display the name by the last position of an object on the map.

Type: Boolean

#### IconID

A unique identifier of icon saved in the icons collection in the server session.

Type: Integer

#### ShowIcon

Information on whether to display the icon by the last position of an object on the map.

Type: Boolean

#### IconColor

The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### PathColor

The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### PathWidth

The width of the track created by the object positions (measured in pixels).

Type: Integer

#### Size

The size of the position marker in the track, measured in pixels.

Type: Integer

#### RemovePreviousPositions

Information on whether to delete the previous object positions while localizing new positions of the object.

Type: Boolean

#### PointsConnected

Information on whether to connect the object positions into a track.

Type: Boolean

#### ShowDirection

Information on whether to display direction arrows on track lines.

Type: Boolean

#### FontParams

A font of object name displayed on maps.

Type: TSoapTFontParameters

### LocalizeObjectAddWithPositions function.

Adds a new object to the localized objects collection saved in the server session. The object is appended at the end of the collection. The object is added together with a list of positions.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique object identifier.

Type: Integer

#### Name

Object name displayed by the last position of an object on the map, providing the ShowName option is active.

Type: WideString

#### ShowName

Information on whether to display the name by the last position of an object on the map.

Type: Boolean

#### IconID

A unique identifier of icon saved in the icons collection in the server session.

Type: Integer

#### ShowIcon

Information on whether to display the icon by the last position of an object on the map.

Type: Boolean

#### IconColor

The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### PathColor

The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### PathWidth

The width of the track created by the object positions (measured in pixels).

Type: Integer

#### Size

The size of the position marker in the track, measured in pixels.

Type: Integer

#### RemovePreviousPositions

Information on whether to delete the previous object positions while localizing new positions of the object.

Type: Boolean

#### PointsConnected

Information on whether to connect the object positions into a track.

Type: Boolean

#### ShowDirection

Information on whether to display direction arrows on track lines.

Type: Boolean

#### FontParams

A font of object name displayed on maps.

Type: TSoapTFontParameters

#### ObjectPositions

A list of positions of the object.

Type: TSoapTLocalizeObjectPositionDataArray

#### StringFields

Values for all string fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).

Type: TSoapTWideStringArrayArray

#### FloatFields

Values for all numeric fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).

Type: TSoapTFloatArrayArray

### LocalizeObjectClear function.

Removes all objects from the localized objects collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeObjectEntityIDToItemIndex function.

Returns an index of an object in the localized objects collection saved in the server session - the object with the given identifier .

Module: LocalizeModule

Result type: TSoapLocalizeObjectEntityIDToItemIndex__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique object identifier.

Type: Integer

### LocalizeObjectGet function.

Returns properties of an object contained in the localized objects collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeObjectGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ItemIndex

Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.

Type: Integer

#### ShowDirection

Information on whether to display direction arrows on track lines.

Type: Boolean

### LocalizeObjectGetCount function.

Returns the number of objects in the localized objects collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeObjectGetCount__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeObjectPositionAdd function.

Adds a new object position to the positions collection of the given localized object saved in the server session. The position is appended at the end of the collection. If the RemovePreviousPositions option is active for the localized object, earlier added positions are removed. The new position is from now displayed on maps rendered for the session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique localized object identifier.

Type: Integer

#### NumFields

Values for all numeric fields contained in the collection saved in the server session.

Type: TFloatArray

#### StrFields

Values for all string fields contained in the collection saved in the server session.

Type: TWideStringArray

#### PositionPoint

Geographic coordinates of the position point.

Type: TSoapTLongLatPoint

#### Time

Time (in the GMT time zone) of the position (number of days since 30-12-1899 12:00 AM).

Type: Double

#### Description

The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.

Type: WideString

#### ShowDescription

Information on whether to display the description of the position of the object on the map.

Type: Boolean

#### ShowName

Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).

Type: Boolean

#### IconID

A unique identifier of icon saved in the icons collection in the server session.

Type: Integer

#### ShowIcon

Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).

Type: Boolean

#### IconColor

The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### FontParams

A font of position description displayed on maps.

Type: TSoapTFontParameters

### LocalizeObjectPositionClear function.

Removes all object positions from the positions collection of the given localized object saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique localized object identifier.

Type: Integer

### LocalizeObjectPositionGet function.

Returns properties of an object position contained in the positions collection of the given localized object saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeObjectPositionGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique localized object identifier.

Type: Integer

#### ItemIndex

Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.

Type: Integer

### LocalizeObjectPositionGetCount function.

Returns the number of object positions in the positions collection of the given localized object saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeObjectPositionGetCount__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique localized object identifier.

Type: Integer

### LocalizeObjectPositionRemove function.

Removes an object position from the positions collection of the given localized object saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique localized object identifier.

Type: Integer

#### ItemIndex

Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.

Type: Integer

### LocalizeObjectPositionSet function.

Changes properties of an object position contained in the positions collection of the given localized object saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntityID

The unique localized object identifier.

Type: Integer

#### ItemIndex

Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.

Type: Integer

#### NumFields

Values for all numeric fields contained in the collection saved in the server session.

Type: TFloatArray

#### StrFields

Values for all string fields contained in the collection saved in the server session.

Type: TWideStringArray

#### PositionPoint

Geographic coordinates of the position point.

Type: TSoapTLongLatPoint

#### Time

Time (in the GMT time zone) of the position (number of days since 30-12-1899 12:00 AM).

Type: Double

#### Description

The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.

Type: WideString

#### ShowDescription

Information on whether to display the description of the position of the object on the map.

Type: Boolean

#### ShowName

Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).

Type: Boolean

#### IconID

A unique identifier of icon saved in the icons collection in the server session.

Type: Integer

#### ShowIcon

Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).

Type: Boolean

#### IconColor

The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### FontParams

A font of position description displayed on maps.

Type: TSoapTFontParameters

### LocalizeObjectRemove function.

Removes an object from the localized objects collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ItemIndex

Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.

Type: Integer

### LocalizeObjectSet function.

Changes properties of an object contained in the localized objects collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ItemIndex

Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.

Type: Integer

#### EntityID

The unique object identifier.

Type: Integer

#### Name

Object name displayed by the last position of an object on the map, providing the ShowName option is active.

Type: WideString

#### ShowName

Information on whether to display the name by the last position of an object on the map.

Type: Boolean

#### IconID

A unique identifier of icon saved in the icons collection in the server session.

Type: Integer

#### ShowIcon

Information on whether to display the icon by the last position of an object on the map.

Type: Boolean

#### IconColor

The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### PathColor

The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### PathWidth

The width of the track created by the object positions (measured in pixels).

Type: Integer

#### Size

The size of the position marker in the track, measured in pixels.

Type: Integer

#### RemovePreviousPositions

Information on whether to delete the previous object positions while localizing new positions of the object.

Type: Boolean

#### PointsConnected

Information on whether to connect the object positions into a track.

Type: Boolean

#### ShowDirection

Information on whether to display direction arrows on track lines.

Type: Boolean

#### FontParams

A font of object name displayed on maps.

Type: TSoapTFontParameters

### LocalizeSetObjectVisibility function.

Changes the visibility of all localized object in collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ObjectVisibility

A list of localized objects visibility informations. Length of the list must equal the number of objects in the localized objects collection.

Type: TBooleanArray

### LocalizeStrFieldsAdd function.

Adds a new field to the string fields collection saved in the server session. The field is appended at the end of the collection.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Name

Field name.

Type: WideString

#### ShowOnInfo

Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.

Type: Boolean

### LocalizeStrFieldsClear function.

Removes all fields from the string fields collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeStrFieldsGet function.

Returns properties of a field contained in the string fields collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeStrFieldsGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.

Type: Integer

### LocalizeStrFieldsGetCount function.

Returns the number of fields in the string fields collection saved in the server session.

Module: LocalizeModule

Result type: TSoapLocalizeStrFieldsGetCount__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### LocalizeStrFieldsRemove function.

Removes a field from the string fields collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.

Type: Integer

### LocalizeStrFieldsSet function.

Changes properties of a field contained in the string fields collection saved in the server session.
Returns value from error code table.

Module: LocalizeModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.

Type: Integer

#### Name

Field name.

Type: WideString

#### ShowOnInfo

Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.

Type: Boolean

### MapBaseConnect function.

Connects given server session to a database described with connection string and opens a object set containing records from the database. Any previous connection of the same database type should be closed by the session before - only one database of each type can be opened.

Module: ObjectsModule

Result type: TSoapMapBaseConnect__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

#### ConnectionString

Connection parameters transferred as a semicolon separated string in form "Parameter1=Value1;Parameter2=Value2;...". Available parameters are: DBName (it should be one of available database names returned by GetDatabaseList function), UserName, UserPassword. Parameters may be placed in any order.

Type: TConnectionString

### MapBaseDisconnect function.

Disconnects given server session from a database. Some connection of given database type should be active before.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

### MapBaseLoadFromBlob function.

Loads a database file (*.emd for objects or *.eld for logistics) and opens the database for current session only with administrative privileges. Function has same effect as if a database would be opened using MapBaseConnect function, so the connection should be finalized by a call of MapBaseDisconnect function.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

#### BinaryData

A database file content.

Type: TByteDynArray

### MapBaseStoreToBlob function.

Returns current content of a database loaded previously using MapBaseLoadFromBlob function (for saving of any database changes to a file).

Module: ObjectsModule

Result type: TSoapMapBaseStoreToBlob__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DatabaseType

A type of database. Currently available are: Objects, Logistics.

Type: WideString

### MultiGeocodeEx function.

Translates addresses to their geographic coordinates. More than one result for each address can be proposed. The function returns addresses found and the geocode levels for each proposal.

Module: SearchModule

Result type: TSoapMultiGeocodeEx__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ASCIISearch

This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).

Type: Boolean

#### InputPoints

An address to be geocoded.

Type: TSoapTGeocodePointInfoExArray

#### MaxResultCount

Maximal result count. Function returns at most 100 results, so if the value is greater, length of resultant lists should be checked.

Type: Integer

### PostGroup function.

Posts new data for object group identified by given ID. The group should be locked by EditGroup before. After success object group will be unlocked.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

#### GroupSettings

Visual settings of the object group.

Type: TSoapTGroupSettings

#### VisibleFields

Names of fields essential for the object group - other fields in object set are not important for the object group.

Type: TWideStringArray

### PostObject function.

Posts new data for object identified by given ID. The object should be locked by EditObject before. After success object will be unlocked.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### GroupID

Object group identifier.

Type: TRecordID

#### FieldNames

Names of object fields to be changed. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

#### FieldValues

Values for corresponding object fields.

Type: TWideStringArray

#### ObjectPosition

Object geographic data.

Type: TSoapTObjectPosition

#### CaptionPosition

Position of object name being drawn on maps nearby its icon. It is the alignment of object name with reference to its icon. Supported values are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07

Type: TCaptionPosition

### PostObjects function.

Posts new data for a set of objects identified by given IDs.

Module: ObjectsModule

Result type: TSoapPostObjects__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectIDs

Object identifiers.

Type: TWideStringArray

#### GroupIDs

Object group identifiers.

Type: TWideStringArray

#### FieldNames

Names of object fields to be changed. The list of all fields in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

#### FieldValues

Values for corresponding objects and their fields.

Type: TSoapTWideStringArrayArray

#### ObjectPosition

A list of object geographic datas.

Type: TSoapTObjectPositionArray

#### CaptionPosition

A list of positions of object name being drawn on maps nearby its icon. It is the alignment of object name with reference to its icon. Supported values are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07

Type: TCaptionPositionArray

### ReloadMapFiles function.

Realoads all map files placed in subdirectory DATA of server installation directory. All loaded map files are activated by default.
Returns value from error code table.

Module: BaseModule

Result type: Integer

### RenderMapOnHWNDByPoint function.

Generates a map with a middle in a given point. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of all four corner points of the resultant map are returned, too.

Module: MapModule

Result type: TSoapRenderMapOnHWNDByPoint__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

The middle point of requested map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of requested map image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of requested map image. It must be positive value.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of rendered image.

Type: TSoapTImageRenderParams

#### HWND

Handle of the control, which the map is rendered on.

Type: Integer

### RenderMapOnHWNDByPointWithCopyright function.

Generates a map with a middle in a given point. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.

Module: MapModule

Result type: TSoapRenderMapOnHWNDByPointWithCopyright__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MiddlePoint

The middle point of requested map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of requested map image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of requested map image. It must be positive value.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of rendered image.

Type: TSoapTImageRenderParams

#### HWND

Handle of the control, which the map is rendered on.

Type: Integer

### RenderMapOnHWNDByRect function.

Generates a map bounded by a given rectangle. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and the canvas may differ, so in addition the function returns effective corner points of the resultant map.

Module: MapModule

Result type: TSoapRenderMapOnHWNDByRect__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### LeftUpPoint

Geographic coordinates of the left-up point of the requested map.

Type: TSoapTLongLatPoint

#### RightBottomPoint

Geographic coordinates of the bottom-down point of the requested map.

Type: TSoapTLongLatPoint

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of requested map image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of requested map image. It must be positive value.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of rendered image.

Type: TSoapTImageRenderParams

#### HWND

Handle of the control, which the map is rendered on.

Type: Integer

### RenderMapOnHWNDByRectWithCopyright function.

Generates a map bounded by a given rectangle. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and the canvas may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.

Module: MapModule

Result type: TSoapRenderMapOnHWNDByRectWithCopyright__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### LeftUpPoint

Geographic coordinates of the left-up point of the requested map.

Type: TSoapTLongLatPoint

#### RightBottomPoint

Geographic coordinates of the bottom-down point of the requested map.

Type: TSoapTLongLatPoint

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of requested map image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of requested map image. It must be positive value.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of rendered image.

Type: TSoapTImageRenderParams

#### HWND

Handle of the control, which the map is rendered on.

Type: Integer

### RenderMapOnImageByPoint function.

Generates a map as image file with a middle in a given point. Geographic coordinates of all four corner points of the resultant map are returned, too.

Module: MapModule

Result type: TSoapRenderMapOnImageByPoint__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned image. Supported formats can be received using GetAvailableImageFormats function.

Type: WideString

#### MiddlePoint

The middle point of requested map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of requested map image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of requested map image. It must be positive value.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of returned image.

Type: TSoapTImageRenderParams

### RenderMapOnImageByPointWithCopyright function.

Generates a map as image file with a middle in a given point. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.

Module: MapModule

Result type: TSoapRenderMapOnImageByPointWithCopyright__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned image. Supported formats can be received using GetAvailableImageFormats function.

Type: WideString

#### MiddlePoint

The middle point of requested map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of requested map image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of requested map image. It must be positive value.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of returned image.

Type: TSoapTImageRenderParams

### RenderMapOnImageByRect function.

Generates a map as image file bounded by a given rectangle. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested image may differ, so in addition the function returns effective corner points of the resultant map.

Module: MapModule

Result type: TSoapRenderMapOnImageByRect__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned image. Supported formats can be received using GetAvailableImageFormats function.

Type: WideString

#### LeftUpPoint

Geographic coordinates of the left-up point of the requested map.

Type: TSoapTLongLatPoint

#### RightBottomPoint

Geographic coordinates of the bottom-down point of the requested map.

Type: TSoapTLongLatPoint

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of requested map image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of requested map image. It must be positive value.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of returned image.

Type: TSoapTImageRenderParams

### RenderMapOnImageByRectWithCopyright function.

Generates a map as image file bounded by a given rectangle. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested image may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.

Module: MapModule

Result type: TSoapRenderMapOnImageByRectWithCopyright__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned image. Supported formats can be received using GetAvailableImageFormats function.

Type: WideString

#### LeftUpPoint

Geographic coordinates of the left-up point of the requested map.

Type: TSoapTLongLatPoint

#### RightBottomPoint

Geographic coordinates of the bottom-down point of the requested map.

Type: TSoapTLongLatPoint

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Width of requested map image. It must be positive value.

Type: Integer

#### BitmapHeight

Height of requested map image. It must be positive value.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of returned image.

Type: TSoapTImageRenderParams

### RenderSplitMapOnImageByPoint function.

Generates a map with a middle in a given point. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of all four corner points of the resultant map are returned, too.

Module: MapModule

Result type: TSoapRenderSplitMapOnImageByPoint__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned images. Supported formats can be received using GetAvailableImageFormats function.

Type: WideString

#### MiddlePoint

The middle point of requested map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Requested total width of map image. It must be positive value.

Type: Integer

#### BitmapHeight

Requested total height of map image. It must be positive value.

Type: Integer

#### TileWidth

Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.

Type: Integer

#### TileHeight

Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of returned images.

Type: TSoapTImageRenderParams

### RenderSplitMapOnImageByPointWithCopyright function.

Generates a map with a middle in a given point. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.

Module: MapModule

Result type: TSoapRenderSplitMapOnImageByPointWithCopyright__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned images. Supported formats can be received using GetAvailableImageFormats function.

Type: WideString

#### MiddlePoint

The middle point of requested map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Requested total width of map image. It must be positive value.

Type: Integer

#### BitmapHeight

Requested total height of map image. It must be positive value.

Type: Integer

#### TileWidth

Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.

Type: Integer

#### TileHeight

Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of returned images.

Type: TSoapTImageRenderParams

### RenderSplitMapOnImageByRect function.

Generates a map bounded by a given rectangle. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested total image may differ, so in addition the function returns effective corner points of the resultant map.

Module: MapModule

Result type: TSoapRenderSplitMapOnImageByRect__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned images. Supported formats can be received using GetAvailableImageFormats function.

Type: WideString

#### LeftUpPoint

Geographic coordinates of the left-up point of the requested map.

Type: TSoapTLongLatPoint

#### RightBottomPoint

Geographic coordinates of the bottom-down point of the requested map.

Type: TSoapTLongLatPoint

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Requested total width of map image. It must be positive value.

Type: Integer

#### BitmapHeight

Requested total height of map image. It must be positive value.

Type: Integer

#### TileWidth

Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.

Type: Integer

#### TileHeight

Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of returned images.

Type: TSoapTImageRenderParams

### RenderSplitMapOnImageByRectWithCopyright function.

Generates a map bounded by a given rectangle. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested total image may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.

Module: MapModule

Result type: TSoapRenderSplitMapOnImageByRectWithCopyright__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned images. Supported formats can be received using GetAvailableImageFormats function.

Type: WideString

#### LeftUpPoint

Geographic coordinates of the left-up point of the requested map.

Type: TSoapTLongLatPoint

#### RightBottomPoint

Geographic coordinates of the bottom-down point of the requested map.

Type: TSoapTLongLatPoint

#### MapRotation

An angle defining a rotation of the map (degrees between 0 and 360).

Type: Double

#### MapTilt

An angle defining a tilt of the map (degrees between -30 and 30).

Type: Double

#### MapProjection

Name of required map projection. Supported projections can be received using GetProjections function.

Type: WideString

#### MapProjectionParams

For future use.

Type: WideString

#### BitmapWidth

Requested total width of map image. It must be positive value.

Type: Integer

#### BitmapHeight

Requested total height of map image. It must be positive value.

Type: Integer

#### TileWidth

Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.

Type: Integer

#### TileHeight

Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.

Type: Integer

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

#### ImageRenderParams

Other parameters of returned images.

Type: TSoapTImageRenderParams

### RenderTiledMap function.

Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher.

Module: MapModule

Result type: TSoapRenderTiledMap__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".

Type: WideString

#### PositionX

X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.

Type: Integer

#### PositionY

Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.

Type: Integer

#### Zoom

Discrete zoom. It must be a value between 0 and 19.

Type: Integer

#### RenderParam

Other parameters of returned images.

Type: TSoapTTiledMapParams

#### TiledMapLayers

List of required layers. List of all supported layers can be received using GetTiledMapLayers function.

Type: TWideStringArray

### RenderTiledMapEx function.

Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher.

Module: MapModule

Result type: TSoapRenderTiledMapEx__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".

Type: WideString

#### PositionX

X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.

Type: Integer

#### PositionY

Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.

Type: Integer

#### Zoom

Discrete zoom. It must be a value between 0 and 19.

Type: Integer

#### RenderParam

Other parameters of returned images.

Type: TSoapTTiledMapParams

#### TiledMapLayers

List of required layers. List of all supported layers can be received using GetTiledMapLayers function.

Type: TWideStringArray

#### VisibleLayers

List of required map layers. List of all map layers can be received using GetDefaultLayers function.

Type: TWideStringArray

### RenderTiledMapWithCopyright function.

Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher. Additionally returns copyrights of the map providers.

Module: MapModule

Result type: TSoapRenderTiledMapWithCopyright__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MimeType

Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".

Type: WideString

#### PositionX

X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.

Type: Integer

#### PositionY

Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.

Type: Integer

#### Zoom

Discrete zoom. It must be a value between 0 and 19.

Type: Integer

#### RenderParam

Other parameters of returned images.

Type: TSoapTTiledMapParams

#### TiledMapLayers

List of required layers. List of all supported layers can be received using GetTiledMapLayers function.

Type: TWideStringArray

### RouteAttributesAddAlongRouteAttribute function.

Adds new polyline road-along placed routing difficulty to the session. Polyline coordinates will be generated automatically between given start and finish points.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesAddAlongRouteAttribute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### StartPoint

Geographic coordinates of the difficulty start point.

Type: TSoapTLongLatPoint

#### FinishPoint

Geographic coordinates of the difficulty finish point.

Type: TSoapTLongLatPoint

#### AttributeParams

Difficulty properties.

Type: TSoapTRouteAttributeParams

#### GenerateID

Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.

Type: Boolean

#### ReturnRepresentation

Option of returning all points of generated polyline.

Type: Boolean

### RouteAttributesAddLineAttribute function.

Adds new polyline routing difficulty to the session.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesAddLineAttribute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Line

Geographic coordinates of all points of the difficulty polyline.

Type: TSoapTLongLatPointArray

#### AttributeParams

Difficulty properties.

Type: TSoapTRouteAttributeParams

#### GenerateID

Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.

Type: Boolean

### RouteAttributesAddPointAttribute function.

Adds new point routing difficulty to the session.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesAddPointAttribute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Position

Geographic coordinates of the difficulty.

Type: TSoapTLongLatPoint

#### AttributeParams

Difficulty properties.

Type: TSoapTRouteAttributeParams

#### GenerateID

Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.

Type: Boolean

### RouteAttributesAddPolygonAttribute function.

Adds new polygonal routing difficulty to the session.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesAddPolygonAttribute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Polygon

Geographic coordinates of all points of the difficulty polygon.

Type: TSoapTLongLatPointArray

#### AttributeParams

Difficulty properties.

Type: TSoapTRouteAttributeParams

#### GenerateID

Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.

Type: Boolean

### RouteAttributesClearRouteAttribute function.

Removes all routing difficulties stored in the session.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteAttributesDeleteRouteAttribute function.

Removes routing difficulty identified by given identifier.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AttributeID

Identifier of difficulty being deleted.

Type: Integer

### RouteAttributesExecuteDataProviderAction function.

Executes one of the action supported for given routing difficulty provider.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Provider

Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.

Type: WideString

#### ActionName

Action name. The list of currently supported actions can be get using RouteAttributesGetDataProviderActions function.

Type: WideString

#### ActionParams

Action params. For future use.

Type: TWideStringArray

### RouteAttributesGetAttributesProviderList function.

Returns a list of supported routing difficulty providers.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesGetAttributesProviderList__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteAttributesGetDataProviderActions function.

Returns all actions supported for given routing difficulty provider.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesGetDataProviderActions__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Provider

Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.

Type: WideString

### RouteAttributesGetDataProviderParams function.

Returns all parameter names and values for given routing difficulty provider.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesGetDataProviderParams__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Provider

Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.

Type: WideString

### RouteAttributesGetPassedAttributesList function.

Retrieves a list of routing difficulties used while the last route calculation (if routeattributes.collectrouteattributes option is on).

Module: RouteAttributesModule

Result type: TSoapRouteAttributesGetPassedAttributesList__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteAttributesGetRouteAttribute function.

Returns properties of routing difficulty identified by given identifier.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesGetRouteAttribute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AttributeID

Identifier of difficulty.

Type: Integer

### RouteAttributesGetRouteAttributes function.

Returns all routing difficulties stored in the session.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesGetRouteAttributes__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteAttributesGetRouteAttributeWithGeometry function.

Returns properties of routing difficulty identified by given identifier together with its gegraphic coordinates.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesGetRouteAttributeWithGeometry__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AttributeID

Identifier of difficulty.

Type: Integer

### RouteAttributesGetSubscribedProvidersList function.

Returns a list of currently subscribed routing difficulty providers.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesGetSubscribedProvidersList__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteAttributesLoadFromBlob function.

Loads routing difficulties from binary representation.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### BinaryRepresentation

Binary representation of routing difficulties.

Type: TByteDynArray

### RouteAttributesModifyAlongRouteAttribute function.

Modifies geographic properties of polyline road-along placed routing difficulty identified by given identifier.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesModifyAlongRouteAttribute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AttributeID

Identifier of difficulty being modified.

Type: Integer

#### StartPoint

New start point coordinates.

Type: TSoapTLongLatPoint

#### FinishPoint

New finish point coordinates.

Type: TSoapTLongLatPoint

#### ReturnRepresentation

Option of returning all points of generated polyline.

Type: Boolean

### RouteAttributesModifyLineAttribute function.

Modifies geographic properties of polyline routing difficulty identified by given identifier.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AttributeID

Identifier of difficulty being modified.

Type: Integer

#### Line

New coordinates.

Type: TSoapTLongLatPointArray

### RouteAttributesModifyPointAttribute function.

Modifies geographic properties of point routing difficulty identified by given identifier.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AttributeID

Identifier of difficulty being modified.

Type: Integer

#### Position

New coordinates.

Type: TSoapTLongLatPoint

### RouteAttributesModifyPolygonAttribute function.

Modifies geographic properties of polygonal routing difficulty identified by given identifier.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AttributeID

Identifier of difficulty being modified.

Type: Integer

#### Polygon

New coordinates.

Type: TSoapTLongLatPointArray

### RouteAttributesSetDataProviderParam function.

Sets a value for given parameter of routing difficulty provider.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Provider

Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.

Type: WideString

#### ParamName

Parameter name. The list of supported parameters can be get using RouteAttributesGetDataProviderParams function.

Type: WideString

#### ParamValue

Parameter value.

Type: WideString

### RouteAttributesSetRouteAttribute function.

Modifies properties of routing difficulty identified by given identifier.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### AttributeID

Identifier of difficulty being modified.

Type: Integer

#### AttributeParams

New difficulty properties.

Type: TSoapTRouteAttributeParams

### RouteAttributesStoreToBlob function.

Stores all routing difficulties to binary representation.

Module: RouteAttributesModule

Result type: TSoapRouteAttributesStoreToBlob__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteAttributesSubscribeToDataProvider function.

Subcribes to one of supported routing difficulty providers.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Provider

Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.

Type: WideString

### RouteAttributesUnsubscribeFromDataProvider function.

Unsubcribes from one of subscribed routing difficulty providers.
Returns value from error code table.

Module: RouteAttributesModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Provider

Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.

Type: WideString

### RouteOptimizerAddEntryDeliveryShipment function.

Adds a new delivery shipment for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### DeliveryShipment

New delivery shipment definition.

Type: TSoapTShipment

### RouteOptimizerAddEntryDeliveryShipments function.

Adds a list of delivery shipments for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### DeliveryShipments

A list of new delivery shipments definitions.

Type: TSoapTShipmentsArray

### RouteOptimizerAddEntryPickupShipment function.

Adds a new pickup shipment for a waypoint. For future use.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### PickupShipment

New pickup shipment definition.

Type: TSoapTShipment

### RouteOptimizerAddEntryPickupShipments function.

Adds a list of pickup shipments for a waypoint. For future use.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### PickupShipments

A list of new pickup shipment definitions.

Type: TSoapTShipmentsArray

### RouteOptimizerAddEntryTimeWindow function.

Adds a new time window for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### TimeWindow

New time window definition.

Type: TSoapTTimeWindow

### RouteOptimizerAddEntryTimeWindows function.

Adds a list of time windows for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### TimeWindows

A list of new time window definitions.

Type: TSoapTTimeWindowsArray

### RouteOptimizerAddShipmentType function.

Defines within the server session a new shipment type which is identified by an arbitrary name.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ShipmentType

Name of the shipment type.

Type: WideString

### RouteOptimizerClearEntryDeliveryShipments function.

Deletes all delivery shipments defined for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RouteOptimizerClearEntryPickupShipments function.

Deletes all pickup shipments defined for a waypoint. For future use.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RouteOptimizerClearEntryTimeWindows function.

Deletes all time windows defined for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RouteOptimizerGetDepotEntry function.

Gets the index of currently set depot waypoint.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerGetDepotEntry__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteOptimizerGetEntryDeliveryShipments function.

Returns a list of all delivery shipments defined for a waypoint.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerGetEntryDeliveryShipments__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RouteOptimizerGetEntryPickupShipments function.

Returns a list of all pickup shipments defined for a waypoint. For future use.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerGetEntryPickupShipments__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RouteOptimizerGetEntryShipmentDeliveryPickupTimes function.

Returns delivery and pickup times defined for a waypoint.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerGetEntryShipmentDeliveryPickupTimes__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RouteOptimizerGetEntryTimeWindows function.

Returns a list of all time windows defined for a waypoint.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerGetEntryTimeWindows__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RouteOptimizerOptimizeRoute function.

Optimizes a route in way of reordering a sequence of waypoints using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route (if it really was calculated) can be opionally stored in the server session for further processing. Function returns new waypoint order and resultant route features.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerOptimizeRoute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### RouteOptimizeType

Route optimization type:
- from start to end = 0x00
- from start to best end = 0x01
- from best start to end = 0x02
- from best start to best end = 0x03
- cycle on all points = 0x04

Type: Integer

#### CalculateRoute

Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.

Type: Boolean

#### ReorderPoints

Indicates whether to store new waypoint order in the session replacing present list of waypoints.

Type: Boolean

#### ReturnRoutePlanEntriesDescription

Option of returning user or automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RouteOptimizerRemoveShipmentType function.

Deletes one of defined shipment types.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ShipmentType

Name of the shipment type to be deleted.

Type: WideString

### RouteOptimizerSetDepotEntry function.

Marks one of the waypoints defined in the server session as a depot.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DepotEntryIndex

Index of the waypoint . It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RouteOptimizerSetEntryDeliveryShipments function.

Sets a new set of delivery shipments for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### DeliveryShipments

A list of delivery shipment definitions.

Type: TSoapTShipmentsArray

### RouteOptimizerSetEntryPickupShipments function.

Sets a new set of pickup shipments for a waypoint. For future use.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### PickupShipments

A list of pickup shipment definitions.

Type: TSoapTShipmentsArray

### RouteOptimizerSetEntryShipmentDeliveryPickupTimes function.

Sets new delivery and pickup times for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### DeliveryTime

Time of shipment delivery (in minutes).

Type: Integer

#### PickupTime

Time of shipment pickup (in minutes).

Type: Integer

### RouteOptimizerSetEntryTimeWindows function.

Sets a new set of time windows for a waypoint.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### TimeWindows

A list of time window definitions.

Type: TSoapTTimeWindowsArray

### RouteOptimizerShipmentTypesClear function.

Removes all shipment types defined in the server session.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteOptimizerShipmentTypesGet function.

Returns a list of currently defined shipment types.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerShipmentTypesGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteOptimizerShipmentTypesSet function.

Sets for the server session a new set of shipment types replacing existing one, if present.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ShipmentTypes

A list of new shipment types.

Type: TWideStringArray

### RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd function.

Adds a new entry to the list of incompatibilities between some two shipment types defined in the server session.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ShipmentType1

First shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.

Type: WideString

#### ShipmentType2

Second shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.

Type: WideString

### RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear function.

Deletes entire list of incompatibilities between some two shipment types.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet function.

Returns a list of all incompatibilities between some shipment types defined in the server session.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet function.

Sets a new set of incompatibilities between shipment types.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ShipmentTypeToShipmentTypeIncompatibility

A list of incompatibility pairs.

Type: TSoapTShipmentTypeToShipmentTypeIncompatibilityArray

### RouteOptimizerSimpleOptimizeRoute function.

Optimizes a route in way of reordering a sequence of waypoints using given vehicle, driver and road parameters. Calculated route (if it really was calculated), waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns new waypoint order and resultant route features.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerSimpleOptimizeRoute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleParams

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### RouteOptimizeType

Route optimization type:
- from start to end = 0x00
- from start to best end = 0x01
- from best start to end = 0x02
- from best start to best end = 0x03
- cycle on all points = 0x04

Type: Integer

#### CalculateRoute

Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.

Type: Boolean

#### ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### StoreDriverParamsInSession

Indicates whether to store given driver parameters in the session replacing present parameters.

Type: Boolean

#### StoreVehicleParamsInSession

Indicates whether to store given vehicle parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoadParamsInSession

Indicates whether to store given road parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoutePlanEntriesInSession

Indicates whether to store given waypoints in the session replacing present list of waypoints.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RouteOptimizerSolveProblem function.

Optimizes a shipment task for shipments defined for route waypoints returning a set of routes for vehicle categories stored in the server session.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerSolveProblem__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd function.

Adds a new entry to the list of incompatibilities between vehicle categories and shipment types defined in the server session.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleCategory

Vehicle category. The list of currently defined categories may be obtained using VehicleRepositoryVehiclesGet function.

Type: WideString

#### ShipmentType

Shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.

Type: WideString

### RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear function.

Deletes entire list of incompatibilities between vehicle categories and shipment types.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet function.

Returns a list of all incompatibilities between vehicle categories and shipment types defined in the server session.

Module: RouteOptimizerModule

Result type: TSoapRouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet function.

Sets a new set of incompatibilities between vehicle categories and shipment types.
Returns value from error code table.

Module: RouteOptimizerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleCategoryToShipmentTypeIncompatibility

A list of incompatibility pairs.

Type: TSoapTVehicleCategoryToShipmentTypeIncompatibilityArray

### RoutePlannerCalculateAlternativeRoutesAndStore function.

Calculates an optimal and at most two alternative routes for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. The function optionally stores calculated routes in route repository. The optimal route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.

Module: RouteRepositoryModule

Result type: TSoapRoutePlannerCalculateAlternativeRoutesAndStore__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### StoreFirstRouteInSession

Indicates whether to store first resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

#### StoreInRepository

Option of storing routes in the repository.

Type: Boolean

#### ReplaceRepository

Option of replacing old routes in the repository.

Type: Boolean

#### UseIdentsArray

Option of storing routes assigned with identifiers.

Type: Boolean

#### IdentsArray

A list of identifiers for routes to be stored.

Type: TDynamicIntegerArray

#### UseColorArray

Option of storing routes assigned with colors.

Type: Boolean

#### ColorArray

A list of colors for routes to be stored.

Type: TDynamicIntegerArray

### RoutePlannerCalculatePointDistanceFromRoute function.

Calculates distances from a route stored in the server session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerCalculatePointDistanceFromRoute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MaxLength

Maximum distance taking into account while distance calculationg (in meters).

Type: Double

#### Points

A list of points.

Type: TSoapTLongLatPointArray

### RoutePlannerCalculatePointWithinRouteBuffer function.

Recognizes whether given points belong to a buffer formed by a route stored in the server session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerCalculatePointWithinRouteBuffer__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### BufferRadius

Buffer radius (in meters).

Type: Double

#### Points

A list of points.

Type: TSoapTLongLatPointArray

### RoutePlannerCalculateRoute function.

Calculates a route for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerCalculateRoute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### ReturnRoutePlanEntriesDescription

Option of returning user or automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerCalculateRouteDistanceMatrix function.

Calculates a set of routes for each given waypoints (from each point as a start point to all others as end points independently)

Module: RoutePlannerModule

Result type: TSoapRoutePlannerCalculateRouteDistanceMatrix__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

Geographic coordinates of start (end) points.

Type: TSoapTLongLatPointArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### AssumeSymetricDistance

Option of missing of reverse route calculation.

Type: Boolean

### RoutePlannerCalculateRouteFromGPSTrack function.

Calculates a route for a given list of waypoints given as a GPS track file using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerCalculateRouteFromGPSTrack__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### BinaryFile

GPS track file stored in blob.

Type: TByteDynArray

#### BinaryFileFormat

File format:
- CSV = 0x00
- PLT = 0x01

Type: Integer

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerCalculateRoutesWithMultipleDepots function.

Calculates a set of routes beginning with given start points (depots). Each destination point is taken as an end point for subsequent route beginning with the nearest start point.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerCalculateRoutesWithMultipleDepots__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DepotEntries

Geographic coordinates of start points.

Type: TSoapTLongLatPointArray

#### DestinationEntries

Geographic coordinates of destination points.

Type: TSoapTLongLatPointArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

### RoutePlannerCalculateRoutesWithMultipleDepotsAndStore function.

Calculates a set of routes beginning with given start points (depots) and optionally stores them in route repository. Each destination point is taken as an end point for subsequent route beginning with the nearest start point.

Module: RouteRepositoryModule

Result type: TSoapRoutePlannerCalculateRoutesWithMultipleDepotsAndStore__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DepotEntries

Geographic coordinates of start points.

Type: TSoapTLongLatPointArray

#### DestinationEntries

Geographic coordinates of destination points.

Type: TSoapTLongLatPointArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### StoreInRepository

Option of storing routes in the repository.

Type: Boolean

#### ReplaceRepository

Option of replacing old routes in the repository.

Type: Boolean

#### UseIdentsArray

Option of storing routes assigned with identifiers.

Type: Boolean

#### IdentsArray

A list of identifiers for routes to be stored.

Type: TDynamicIntegerArray

#### UseColorArray

Option of storing routes assigned with colors.

Type: Boolean

#### ColorArray

A list of colors for routes to be stored.

Type: TDynamicIntegerArray

### RoutePlannerCalculateRoutesWithSingleDepot function.

Calculates a set of routes beginning with common start point (depot). Each destination point is taken as an end point for subsequent route.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerCalculateRoutesWithSingleDepot__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DepotEntry

Geographic coordinates of start point.

Type: TSoapTLongLatPoint

#### DestinationEntries

Geographic coordinates of destination points.

Type: TSoapTLongLatPointArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

### RoutePlannerCalculateRoutesWithSingleDepotAndStore function.

Calculates a set of routes beginning with common start point (depot) and optionally stores them in route repository. Each destination point is taken as an end point for subsequent route.

Module: RouteRepositoryModule

Result type: TSoapRoutePlannerCalculateRoutesWithSingleDepotAndStore__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DepotEntry

Geographic coordinates of start point.

Type: TSoapTLongLatPoint

#### DestinationEntries

Geographic coordinates of destination points.

Type: TSoapTLongLatPointArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### StoreInRepository

Option of storing routes in the repository.

Type: Boolean

#### ReplaceRepository

Option of replacing old routes in the repository.

Type: Boolean

#### UseIdentsArray

Option of storing routes assigned with identifiers.

Type: Boolean

#### IdentsArray

A list of identifiers for routes to be stored.

Type: TDynamicIntegerArray

#### UseColorArray

Option of storing routes assigned with colors.

Type: Boolean

#### ColorArray

A list of colors for routes to be stored.

Type: TDynamicIntegerArray

### RoutePlannerCalculateRouteWithBinaryResult function.

Calculates a route for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).

Module: RoutePlannerModule

Result type: TSoapRoutePlannerCalculateRouteWithBinaryResult__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### ReturnRoutePlanEntriesDescription

Option of returning user or automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerDriverParamsGet function.

Returns current driver parameters stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerDriverParamsGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerDriverParamsSet function.

Sets new driver parameters in the session replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

### RoutePlannerEntriesAdd function.

Adds new waypoints to waypoint list in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntriesAdd__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### RoutePlanVisitTimes

A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

### RoutePlannerEntriesAddWithDescription function.

Adds new waypoints to waypoint list in the session. User description for each waypoint can be set.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### RoutePlanVisitTimes

A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### RoutePlanEntriesDescription

Waypoint descriptions.

Type: TWideStringArray

### RoutePlannerEntriesClear function.

Clears a waypoint list stored in the session.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerEntriesGet function.

Returns waypoint list stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntriesGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerEntriesGetCount function.

Returns a count of waypoints stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntriesGetCount__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerEntriesGetWithSnapPoints function.

Returns waypoint list stored in the session. Additionally waypoint snap points are returned.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntriesGetWithSnapPoints__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerEntriesSet function.

Sets waypoint list in the session replacing present list.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntriesSet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### RoutePlanVisitTimes

A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

### RoutePlannerEntriesSetAsDriveThrough function.

Sets waypoints in the session as precise points or with tollerance.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Entries

Waypoint properties.

Type: TSoapTDriveThroughArray

### RoutePlannerEntriesSetWithDescription function.

Sets waypoint list in the session replacing present list. User description for each waypoint can be set.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### RoutePlanVisitTimes

A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### RoutePlanEntriesDescription

Waypoint descriptions.

Type: TWideStringArray

### RoutePlannerEntryAdd function.

Appends a new waypoint to a waypoint list stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntryAdd__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntry

Geographic waypoint coordinates.

Type: TSoapTLongLatPoint

#### RoutePlanVisitTime

Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

### RoutePlannerEntryAddWithDescription function.

Appends a new waypoint with user description to a waypoint list stored in the session.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntry

Geographic waypoint coordinates.

Type: TSoapTLongLatPoint

#### RoutePlanVisitTime

Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### RoutePlanEntryDescription

Waypoint description.

Type: WideString

### RoutePlannerEntryComplexMove function.

Moves many waypoints at given positions in waypoint list stored in the session to another positons beginning with one specified position.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### OldEntryIndexes

Indices of current waypoint positions in the waypoint list. Each must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: TDynamicIntegerArray

#### NewEntryIndex

Index of a target position in the waypoint list for the first of all waypoints to be moved. It must be a value between 0 and count, when count-1 may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RoutePlannerEntryGet function.

Gets parameters for a given waypoint from waypoint lists stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntryGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RoutePlannerEntryInsert function.

Inserts a new waypoint at a given position of waypoint list stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntryInsert__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of a target position in the waypoint list. It must be a value between 0 and count, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### RoutePlanEntry

Geographic waypoint coordinates.

Type: TSoapTLongLatPoint

#### RoutePlanVisitTime

Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

### RoutePlannerEntryInsertWithDescription function.

Inserts a new waypoint with user description at a given position of waypoint list stored in the session.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of a target position in the waypoint list. It must be a value between 0 and count, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### RoutePlanEntry

Geographic waypoint coordinates.

Type: TSoapTLongLatPoint

#### RoutePlanVisitTime

Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### RoutePlanEntryDescription

Waypoint description.

Type: WideString

### RoutePlannerEntryMove function.

Moves a waypoint from one position in waypoint list stored in the session to another.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### OldEntryIndex

Index of current waypoint position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### NewEntryIndex

Index of a target position in the waypoint list. It must be a value between 0 and count, when count-1 may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RoutePlannerEntryRemove function.

Removes waypoint at given position in waypoint list stored in the session.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

### RoutePlannerEntryReverse function.

Reverses waypoint list.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerEntrySet function.

Sets parameters for a given waypoint from waypoint lists stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerEntrySet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### RoutePlanEntry

Geographic waypoint coordinates.

Type: TSoapTLongLatPoint

#### RoutePlanVisitTime

Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

### RoutePlannerEntrySetWithDescription function.

Sets parameters and user description for a given waypoint from waypoint lists stored in the session.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### EntryIndex

Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### RoutePlanEntry

Geographic waypoint coordinates.

Type: TSoapTLongLatPoint

#### RoutePlanVisitTime

Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### RoutePlanEntryDescription

Waypoint description.

Type: WideString

### RoutePlannerGetAvailableRoadTypes function.

Returns a list of road types.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetAvailableRoadTypes__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerGetParamValue function.

Returns a value for given parameter of routing stored in the session. List of all supported parameters may be obtained by RoutePlannerGetParamValues function.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetParamValue__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ParamName

Parameter name.

Type: WideString

### RoutePlannerGetParamValues function.

Returns values for all parameters of routing stored in the session. For color parameters value must be decimal number corresponding to hexadecimal number 0x00BBGGRR (BB=blue, GG=green, RR=red). Parameter value meanings:
* routeplanentries.flagstyle - style of waypoint indicators:
- 0 = rectangle without description
- 1 = rectangle with waypoint sequential number beginning from number 1 for the first waypoint (default)
- 2 = rectangle with description
- 3 = rectangle with description and waypoint sequential number beginning from number 1 for the first waypoint
- 4 = rectangle with "Start", "Via", "Stop" labels
- 5 = rectangle with multiline description
- 6 = rectangle with multiline description and waypoint sequential number beginning from number 1 for the first waypoint
- 7 = no indicators
- 8 = circle
- 9 = circle with waypoint sequential number beginning from number 1 for the first waypoint
* routeplanentries.startflagcolor - color of the first waypoint indicator (default value is green)
* routeplanentries.viaflagcolor - color of via waypoint indicators (default value is purple)
* routeplanentries.finishflagcolor - color of the last waypoint indicator (default value is green)
* routeplanrepresentation.visible - option of route visibility:
- 0 = disabled
- 1 = enabled (default)
* routeplanrepresentation.color - color of the route (default value is green)
* routeplanrepresentation.width - route width in pixels, only for value 1 for routeplanrepresentation.position parameter (default value is 3)
* routeplanrepresentation.payroadvisible - option of payed route segments visibility:
- 0 = disabled (default)
- 1 = enabled
* routeplanrepresentation.payroadcolor - color of payed route segments (default value is red)
* routeplanrepresentation.payroadwidth - payed route width in pixels, only for value 1 for routeplanrepresentation.position parameter (default value is 3)
* routeplanrepresentation.chargeroadvisible - option of charged route segments visibility:
- 0 = disabled (default)
- 1 = enabled
* routeplanrepresentation.chargeroadcolor - color of charged route segments (default value is red)
* routeplanrepresentation.chargeroadwidth - charged route width in pixels, only for value 1 for routeplanrepresentation.position parameter (default value is 3)
* routeplanrepresentation.viatollroadvisible - option of viaTOLL route segments visibility:
- 0 = disabled (default)
- 1 = enabled
* routeplanrepresentation.viatollroadcolor - color of viaTOLL route segments (default value is red)
* routeplanrepresentation.viatollroadwidth - viaTOLL route width in pixels, only for value 1 for routeplanrepresentation.position parameter (default value is 3)
* routeplanrepresentation.position - route placement:
- 0 = under roads (default)
- 1 = above roads
* routeplanerparams.addpointtosnaplinetocalculation - distance between waypoint and nearest road affects route length:
- 0 = disabled (default)
- 1 = enabled
* routeplanerparams.attachtoroadfromdescription - waypoints are placed on the named road given in function RoutePlannerEntryAddWithDescription:
- 0 = disabled (default)
- 1 = enabled
* routeplanerparams.cleancalculatedrouteondriverparamsmodification - previously calculated route is removed from session after driver parameter modification:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.cleancalculatedrouteonentriesmodification - previously calculated route is removed from session after waypoint list modification:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.cleancalculatedrouteonrouteplanparamsmodification - previously calculated route is removed from session after route planner parameter modification:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.cleancalculatedrouteonvehicleparamsentriesmodification - previously calculated route is removed from session after vehicle parameter modification:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.hardroadrestrictions - impassable roads are always omitted (even if target waypoint is set on that road):
- 0 = disabled (default)
- 1 = enabled
* routeplanerparams.snaptoblockedlinks - waypoint snap points are placed on impassable roads too:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.snaptoferries - waypoints are placed on ferry lines too:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.softferriesrestrictions - ferry lines are used when is no other way, even if they are forbidden:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.useonewayrestritions - one-way restrictions are on:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.useturnrestrictions - turn restrictions are on:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.usesegmentrestrictions - for future use:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.usestoredtimewindows - for future use:
- 0 = disabled(default)
- 1 = enabled
* routeplanerparams.usepayroads - toll-roads are accepted while routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only when there is no other route to the target waypoint
- 2 = hardly disabled - all payed roads are absolutelly forbidden
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.useviatollroads - viaTOLL roads are accepted while routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only when there is no other route to the target waypoint
- 2 = hardly disabled - all viaTOLL roads are absolutelly forbidden
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.usechargeroads - charged roads are accepted while routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only when there is no other route to the target waypoint
- 2 = hardly disabled - all charged roads are absolutelly forbidden
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.useunpavedroads - unpaved roads are accepted while routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only when there is no other route to the target waypoint
- 2 = hardly disabled - all unpaved roads are absolutelly forbidden
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.usemaxvehicleweight - weight restrictions are on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all weight restrictions are ignored
- 1 = softly enabled - weight restrictions are ignored only when there is no other route to the target waypoint
- 2 = hardly enabled - all weight restrictions are taken absolutelly into consideration (default)
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.usemaxvehicleweightperaxle - weight per axle restrictions are on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all weight per axle restrictions are ignored
- 1 = softly enabled - weight per axle restrictions are ignored only when there is no other route to the target waypoint
- 2 = hardly enabled - all weight per axle restrictions are taken absolutelly into consideration (default)
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.usemaxvehiclelength - length restrictions are on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all length restrictions are ignored
- 1 = softly enabled - length restrictions are ignored only when there is no other route to the target waypoint
- 2 = hardly enabled - all length restrictions are taken absolutelly into consideration (default)
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.usemaxvehiclewidth - width restrictions are on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all width restrictions are ignored
- 1 = softly enabled - width restrictions are ignored only when there is no other route to the target waypoint
- 2 = hardly enabled - all width restrictions are taken absolutelly into consideration (default)
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.usemaxvehicleheight - height restrictions are on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all height restrictions are ignored
- 1 = softly enabled - height restrictions are ignored only when there is no other route to the target waypoint
- 2 = hardly enabled - all height restrictions are taken absolutelly into consideration (default)
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.hazmatgeneralhazardousmaterials - hazardous material restrictions are on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly enabled - the restrictions are ignored only when there is no other route to the target waypoint
- 2 = hardly enabled - the restrictions are taken absolutelly into consideration (default)
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.hazmatexplosivematerials - explosive material restrictions are on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly enabled - the restrictions are ignored only when there is no other route to the target waypoint
- 2 = hardly enabled - the restrictions are taken absolutelly into consideration (default)
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.hazmatgoodsharmfultowater - water harmful material restrictions are on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly enabled - the restrictions are ignored only when there is no other route to the target waypoint
- 2 = hardly enabled - the restrictions are taken absolutelly into consideration (default)
- 3 = setting dervied from routeattributes.hardblockedroadattributesrestrictions parameter
* routeplanerparams.recalculaterouteonturnrestrictionfail - a route is recalculated when there is no way to route without turning off restrictions:
- 0 = disabled
- 1 = enabled (default)
* routeplanerparams.breakmatrixcalculationonfail - route matrix is broken at first calculation failure:
- 0 = disabled (default)
- 1 = enabled
* routeplanerparams.raportcrossroads - route itinerary contains crossroads:
- 0 = disabled (default)
- 1 = only crossroad for named streets
- 2 = all crossroads enabled
* routeplanerparams.defaultdrivethroughviapoints - all waypoints (except of the first and the last) are used as drive through waypoints with tollerance:
- 0 = disabled (default)
- 1 = enabled
* routeplanerparams.defaultdrivethroughradius - drive through waypoint radius (drive tollerance in meters):
- 0 = precise waypoints
- any positive value = waypoints with tollerance (default value is 10000 = 10km)
* routeplanerparams.enableregionalroadsfortracks - all regional roads are allowed for trucks:
- 0 = disabled (default)
- 1 = enabled
* routeplanerparams.routereportformat - for future use
* routeoptimizerparams.calcinterpointlengths - route optimizer calculates full routes between waypoints:
- 0 = disabled (default)
- 1 = enabled
* routeoptimizerparams.routeoptimizecalculatetype - type of route calculating while optimization (parameter takes effect when option routeoptimizerparams.calcinterpointlengths is enabled):
- 0 = shortest route
- 1 = quickest route (default)
- 2 = cheapest route
* routeoptimizerparams.planninghorizon - maximal duration of a route planning (in days, default value is 10)
* routeoptimizerparams.maxrouteduration - maximal duration of a single route (in minutes, default value is 540 = 9 hours)
* routeoptimizerparams.maxwaitingtime - maximal time of waiting at a single route point (in minutes, default value is 120 = 2 hours)
* routeoptimizerparams.maxcumuldrivingbeforeshortbreak - maximal duration of a contigous driving without a break (in minutes, default value is 270 = 4.5 hours)
* routeoptimizerparams.drivetimemargin - maximal tollerance time at a single route point (in minutes, default value is 2)
* routeoptimizerparams.drivetimemarginpercent - maximal tollerance at a single route point (in percents, default value is 5)
* routeoptimizerparams.loadingtimemargin - maximal tollerance for shipment loading time at a single route point (in minutes, default value is 2)
* routeoptimizerparams.loadingtimemarginpercent - maximal tollerance for shipment loading at a single route point (in percents, default value is 5)
* routeoptimizerparams.unloadingtimemargin - maximal tollerance for shipment unloading time at a single route point (in minutes, default value is 2)
* routeoptimizerparams.unloadingtimemarginpercent - maximal tollerance for shipment unloading at a single route point (in percents, default value is 5)
* routeoptimizerparams.separatediffrentpoints - assumption of non-zero distance between two equivalent route points:
- 0 = disabled
- 1 = enabled (default)
* routeattributes.hardblockedroadattributesrestrictions - impassable traffic difficulties are always omitted (even if the target waypoint is set within the difficulty):
- 0 = disabled (default) - all difficulty parameters are ignored when routing to the target waypoint
- 1 = enabled - all difficulty parameters are taken absolutelly into consideration
- 2 = enabled - all difficulty parameters except of Closed parameter are taken absolutelly into consideration, but Closed is ignored when routing to the target waypoint
* routeattributes.allowentertoblockedzone - impassable difficulties being zones blocked for routing are ignored when the target waypoint is set in such zone:
- 0 = disabled (default)
- 1 = enabled
* routeattributes.collectrouteattributes - routing difficulties are collected for analyze purposes:
- 0 = disabled (default)
- 1 = enabled
* routeattributes.showblockedattributes - routing difficulties which have influenced on the last calculated route are drawn on maps as red bubbles:
- 0 = disabled (default)
- 1 = enabled
* routeattributes.showvisitedattributes - routing difficulties which were taken into account but haven't influenced on the last calculated route are drawn on maps as green bubbles:
- 0 = disabled (default)
- 1 = enabled
* routeattributes.maxaltitudeforattributes - maximal altitude for bubbles drawn after setting up routeattributes.showblockedattributes or routeattributes.showvisitedattributes (default value 0 means no limit)
* routeattributes.speedprofilestype - for future use
* logistictollattributes.currentcurrency - current currency 3-letter international abbreviation (default value is PLN)
* logistictollattributes.preferedvinettespandays - vinette time perdiod for vinette road (in days, default value is 7-14)
* logistictollattributes.defaultaxles - default number of axles for vehicles (default value is 2)
* logistictollattributes.defaultemission - default emission standard for vehicles (default value is 5)
* logistictollattributes.defaulthasdpf - vehicles are supported with the DPF filter:
- 0 = disabled
- 1 = enabled (default)
* logistictollattributes.notaxcosts - costs are returned without the tax:
- 0 = disabled (default)
- 1 = enabled

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetParamValues__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerGetRouteItinerary function.

Returns an itinerary for a claculated route stored in the server session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetRouteItinerary__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerGetRouteLogisticTOLLSummary function.

Returns toll costs for a calaculated route stored in the server session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetRouteLogisticTOLLSummary__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerGetRouteRepresentation function.

Returns geographic route representation for a claculated route stored in the server session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetRouteRepresentation__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerGetRouteRepresentationWithBinaryResult function.

Returns geographic route representation in binary format for a claculated route stored in the server session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetRouteRepresentationWithBinaryResult__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerGetRouteSummary function.

Returns summary for a claculated route stored in the server session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetRouteSummary__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

### RoutePlannerGetRouteViaTollSummary function.

Returns viaTOLL summary for a calaculated route stored in the server session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerGetRouteViaTollSummary__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerRoadParamsGet function.

Returns current road parameters stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerRoadParamsGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerRoadParamsSet function.

Sets new road parameters in the session replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

### RoutePlannerRoadViaTollParamsGet function.

Returns current viaTOLL parameters stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerRoadViaTollParamsGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerRoadViaTollParamsSet function.

Sets new viaTOLL parameters in the session replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ViaTollRoadParams

New viaTOLL parameters.

Type: TSoapTRoadViaTollParamsArray

### RoutePlannerRouteClear function.

Removes a route last calculated and stored in the session.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerRouteLoadFromBlob function.

Loads current route from binary representation.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### BinaryRepresentation

Binary route representation.

Type: TByteDynArray

### RoutePlannerRouteLoadFromDatabase function.

Loads current route from database.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ObjectID

Object identifier.

Type: TRecordID

### RoutePlannerRouteStoreToBlob function.

Stores current route to binary representation.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerRouteStoreToBlob__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerRouteStoreToDatabase function.

Stores current route to database.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ObjectID

Object identifier.

Type: TRecordID

### RoutePlannerSetParamValue function.

Sets a value for given parameter of routing stored in the session. List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ParamName

Parameter name.

Type: WideString

#### ParamValue

Parameter value.

Type: WideString

### RoutePlannerSimpleCalculateAlternativeRoutesAndStore function.

Calculates an optimal and at most two alternative routes for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters, and optionally stores them in route repository. The optimal route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.

Module: RouteRepositoryModule

Result type: TSoapRoutePlannerSimpleCalculateAlternativeRoutesAndStore__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleEntry

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### ViaTollParams

viaTOLL parameters.

Type: TSoapTRoadViaTollParamsArray

#### RoutePlannerParams

A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.

Type: TWideStringArray

#### SubscribeProviders

A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.

Type: TWideStringArray

#### DriveThroughEntries

Waypoint settings as precise points or with tollerance.

Type: TSoapTDriveThroughArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### StoreFirstRouteInSession

Indicates whether to store first resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

#### StoreInRepository

Option of storing routes in the repository.

Type: Boolean

#### ReplaceRepository

Option of replacing old routes in the repository.

Type: Boolean

#### UseIdentsArray

Option of storing routes assigned with identifiers.

Type: Boolean

#### IdentsArray

A list of identifiers for routes to be stored.

Type: TDynamicIntegerArray

#### UseColorArray

Option of storing routes assigned with colors.

Type: Boolean

#### ColorArray

A list of colors for routes to be stored.

Type: TDynamicIntegerArray

#### StoreDriverParamsInSession

Indicates whether to store given driver parameters in the session replacing present parameters.

Type: Boolean

#### StoreVehicleParamsInSession

Indicates whether to store given vehicle parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoadParamsInSession

Indicates whether to store given road parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoutePlanEntriesInSession

Indicates whether to store given waypoints in the session replacing present list of waypoints.

Type: Boolean

#### StoreRoutePlannerParamsInSession

Indicates whether to store given routing parameters in the session replacing present parameters.

Type: Boolean

#### StoreSubscribeProvidersInSession

Indicates whether to set given routing difficulty provider list in the session replacing present list.

Type: Boolean

#### StoreDriveThroughEntriesInSession

Indicates whether to store given waypoint properties in the session replacing present properties.

Type: Boolean

### RoutePlannerSimpleCalculateRoute function.

Calculates a route for a given list of waypoints using given vehicle, driver and road parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerSimpleCalculateRoute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleParams

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### CalculateRoute

Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.

Type: Boolean

#### ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### StoreDriverParamsInSession

Indicates whether to store given driver parameters in the session replacing present parameters.

Type: Boolean

#### StoreVehicleParamsInSession

Indicates whether to store given vehicle parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoadParamsInSession

Indicates whether to store given road parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoutePlanEntriesInSession

Indicates whether to store given waypoints in the session replacing present list of waypoints.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerSimpleCalculateRoute2 function.

Calculates a route for a given list of waypoints using given vehicle, driver, road and viaTOLL parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerSimpleCalculateRoute2__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleEntry

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### ViaTollParams

viaTOLL parameters.

Type: TSoapTRoadViaTollParamsArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### CalculateRoute

Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.

Type: Boolean

#### ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### ReturnViaTollRoadResults

Option of returning resultant viaTOLL results divided into separated road types.

Type: Boolean

#### StoreDriverParamsInSession

Indicates whether to store given driver parameters in the session replacing present parameters.

Type: Boolean

#### StoreVehicleParamsInSession

Indicates whether to store given vehicle parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoadParamsInSession

Indicates whether to store given road parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoutePlanEntriesInSession

Indicates whether to store given waypoints in the session replacing present list of waypoints.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerSimpleCalculateRoute2WithBinaryResult function.

Calculates a route for a given list of waypoints using given vehicle, driver, road and viaTOLL parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).

Module: RoutePlannerModule

Result type: TSoapRoutePlannerSimpleCalculateRoute2WithBinaryResult__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleEntry

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### ViaTollParams

viaTOLL parameters.

Type: TSoapTRoadViaTollParamsArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### CalculateRoute

Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.

Type: Boolean

#### ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### ReturnViaTollRoadResults

Option of returning resultant viaTOLL results divided into separated road types.

Type: Boolean

#### StoreDriverParamsInSession

Indicates whether to store given driver parameters in the session replacing present parameters.

Type: Boolean

#### StoreVehicleParamsInSession

Indicates whether to store given vehicle parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoadParamsInSession

Indicates whether to store given road parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoutePlanEntriesInSession

Indicates whether to store given waypoints in the session replacing present list of waypoints.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerSimpleCalculateRoute3 function.

Calculates a route for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerSimpleCalculateRoute3__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleEntry

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### ViaTollParams

viaTOLL parameters.

Type: TSoapTRoadViaTollParamsArray

#### RoutePlannerParams

A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.

Type: TWideStringArray

#### SubscribeProviders

A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.

Type: TWideStringArray

#### DriveThroughEntries

Waypoint settings as precise points or with tollerance.

Type: TSoapTDriveThroughArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### CalculateRoute

Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.

Type: Boolean

#### ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### ReturnViaTollRoadResults

Option of returning resultant viaTOLL results divided into separated road types.

Type: Boolean

#### ReturnLogisticTOLLResults

Option of returning toll road costs divided into separated countries.

Type: Boolean

#### StoreDriverParamsInSession

Indicates whether to store given driver parameters in the session replacing present parameters.

Type: Boolean

#### StoreVehicleParamsInSession

Indicates whether to store given vehicle parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoadParamsInSession

Indicates whether to store given road parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoutePlanEntriesInSession

Indicates whether to store given waypoints in the session replacing present list of waypoints.

Type: Boolean

#### StoreRoutePlannerParamsInSession

Indicates whether to store given routing parameters in the session replacing present parameters.

Type: Boolean

#### StoreSubscribeProvidersInSession

Indicates whether to set given routing difficulty provider list in the session replacing present list.

Type: Boolean

#### StoreDriveThroughEntriesInSession

Indicates whether to store given waypoint properties in the session replacing present properties.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerSimpleCalculateRoute3WithBinaryResult function.

Calculates a route for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).

Module: RoutePlannerModule

Result type: TSoapRoutePlannerSimpleCalculateRoute3WithBinaryResult__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleEntry

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### ViaTollParams

viaTOLL parameters.

Type: TSoapTRoadViaTollParamsArray

#### RoutePlannerParams

A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.

Type: TWideStringArray

#### SubscribeProviders

A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.

Type: TWideStringArray

#### DriveThroughEntries

Waypoint settings as precise points or with tollerance.

Type: TSoapTDriveThroughArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### CalculateRoute

Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.

Type: Boolean

#### ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### ReturnViaTollRoadResults

Option of returning resultant viaTOLL results divided into separated road types.

Type: Boolean

#### ReturnLogisticTOLLResults

Option of returning toll road costs divided into separated countries.

Type: Boolean

#### StoreDriverParamsInSession

Indicates whether to store given driver parameters in the session replacing present parameters.

Type: Boolean

#### StoreVehicleParamsInSession

Indicates whether to store given vehicle parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoadParamsInSession

Indicates whether to store given road parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoutePlanEntriesInSession

Indicates whether to store given waypoints in the session replacing present list of waypoints.

Type: Boolean

#### StoreRoutePlannerParamsInSession

Indicates whether to store given routing parameters in the session replacing present parameters.

Type: Boolean

#### StoreSubscribeProvidersInSession

Indicates whether to set given routing difficulty provider list in the session replacing present list.

Type: Boolean

#### StoreDriveThroughEntriesInSession

Indicates whether to store given waypoint properties in the session replacing present properties.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerSimpleCalculateRouteWithBinaryResult function.

Calculates a route for a given list of waypoints using given vehicle, driver and road parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).

Module: RoutePlannerModule

Result type: TSoapRoutePlannerSimpleCalculateRouteWithBinaryResult__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleParams

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### CalculateRoute

Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.

Type: Boolean

#### ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

Type: Boolean

#### ReturnRouteRepresentation

Option of returning geographic route representation - a list of all points forming a route.

Type: Boolean

#### ReturnRouteItinerary

Option of returning resultant route itinerary - a list of all route events.

Type: Boolean

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

#### StoreDriverParamsInSession

Indicates whether to store given driver parameters in the session replacing present parameters.

Type: Boolean

#### StoreVehicleParamsInSession

Indicates whether to store given vehicle parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoadParamsInSession

Indicates whether to store given road parameters in the session replacing present parameters.

Type: Boolean

#### StoreRoutePlanEntriesInSession

Indicates whether to store given waypoints in the session replacing present list of waypoints.

Type: Boolean

#### StoreRouteInSession

Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.

Type: Boolean

### RoutePlannerVehicleParamExGet function.

Returns current value for additional vehicle parameter stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerVehicleParamExGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ParamName

Parameter name.

Type: WideString

### RoutePlannerVehicleParamExSet function.

Sets a new value for additional vehicle parameter in the session.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ParamName

Parameter name.

Type: WideString

#### PasamValue

Parameter value.

Type: WideString

### RoutePlannerVehicleParamsExGet function.

Returns current values for all additional vehicle parameters stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerVehicleParamsExGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerVehicleParamsGet function.

Returns current vehicle parameters stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerVehicleParamsGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerVehicleParamsGet2 function.

Returns current extended vehicle parameters stored in the session.

Module: RoutePlannerModule

Result type: TSoapRoutePlannerVehicleParamsGet2__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RoutePlannerVehicleParamsSet function.

Sets new vehicle parameters in the session replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleParams

### RoutePlannerVehicleParamsSet2 function.

Sets new extended vehicle parameters in the session replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleEntry

Vehicle parameters.

Type: TSoapTVehicleEntry

### RouteRepositoryAddRoute function.

Adds a new (last calculated) route to the repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteRepositoryAddRouteWithIdent function.

Adds a new (last calculated) identified route to the repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

### RouteRepositoryCalculatePointDistanceFromRoute function.

Calculates distances from a routes stored in the server session's repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryCalculatePointDistanceFromRoute__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### MaxLength

Maximum distance taking into account while distance calculationg (in meters).

Type: Double

#### Points

A list of points.

Type: TSoapTLongLatPointArray

### RouteRepositoryClear function.

Clears the route repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteRepositoryFetchRoute function.

Fetches existing route from the repository. It becomes current session route.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

### RouteRepositoryFetchRouteWithIdent function.

Fetches existing route from the repository. It becomes current session route.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

### RouteRepositoryGetRouteItinerary function.

Returns itinerary for route existing in the repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryGetRouteItinerary__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

### RouteRepositoryGetRouteItineraryByIdent function.

Returns itinerary for route existing in the repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryGetRouteItineraryByIdent__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

### RouteRepositoryGetRouteRepresentation function.

Returns geographic route representation for route existing in the repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryGetRouteRepresentation__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

### RouteRepositoryGetRouteRepresentationByIdent function.

Returns geographic route representation for route existing in the repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryGetRouteRepresentationByIdent__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

### RouteRepositoryGetRoutes function.

Returns all routes stored in the repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryGetRoutes__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteRepositoryGetRoutesCount function.

Returns the count of routes stored int the repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryGetRoutesCount__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### RouteRepositoryGetRouteSummary function.

Returns summary for route existing in the repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryGetRouteSummary__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

### RouteRepositoryGetRouteSummaryByIdent function.

Returns summary for route existing in the repository.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryGetRouteSummaryByIdent__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

#### ReturnRoadResults

Option of returning resultant route results divided into separated road types.

Type: Boolean

### RouteRepositoryLoadFromBlob function.

Loads route repository from binary representation.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### BinaryRepresentation

Binary representation of route repository.

Type: TByteDynArray

### RouteRepositoryRemove function.

Removes existing route from the repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

### RouteRepositoryRemoveWithIdent function.

Removes existing route from the repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

### RouteRepositoryReplaceRoute function.

Raplaces existing route in the route repository with the last calculated.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

### RouteRepositoryReplaceRouteWithIdent function.

Raplaces existing route in the route repository with the last calculated.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

### RouteRepositorySetRouteColor function.

Sets color for route existing in the repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

#### Color

New route color.

Type: Integer

### RouteRepositorySetRouteColorByIdent function.

Sets color for route existing in the repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

#### Color

New route color.

Type: Integer

### RouteRepositorySetRouteDescription function.

Sets description for route existing in the repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

#### Description

Route description.

Type: WideString

### RouteRepositorySetRouteDescriptionByIdent function.

Sets description for route existing in the repository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

#### Description

Route description.

Type: WideString

### RouteRepositorySetRouteVisibility function.

Enables/disables visibility on maps of route existing in the respository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Index

Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.

Type: Integer

#### Visibility

Route visibility.

Type: Boolean

### RouteRepositorySetRouteVisibilityByIdent function.

Enables/disables visibility on maps of route existing in the respository.
Returns value from error code table.

Module: RouteRepositoryModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Ident

Route identifier.

Type: Integer

#### Visibility

Route visibility.

Type: Boolean

### RouteRepositoryStoreToBlob function.

Stores route repository to binary representation.

Module: RouteRepositoryModule

Result type: TSoapRouteRepositoryStoreToBlob__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### SearchAddCityToSelection function.

Adds found city to session selection. Name of the city will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic information about boundaries and middle point of the city.

Module: SearchModule

Result type: TSoapSearchAddCityToSelection__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### CityNum

The number of city being an index in the list created in the session context by SearchSelectCities function. Value 0 is the first index.

Type: Integer

### SearchAddObjectToSelection function.

Adds found map element to session selection. Name and area of the element will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic information about boundaries and middle point of the element.

Module: SearchModule

Result type: TSoapSearchAddObjectToSelection__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ObjectNum

The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index.

Type: Integer

### SearchAddStreetCrossingToSelection function.

Searches for a crossing for two streets and adds it to session selection. Found crossing will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic coordinates of the crossing point.

Module: SearchModule

Result type: TSoapSearchAddStreetCrossingToSelection__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### StreetHandleA

A handle to the first street. The handle to a street found by SearchSelectItems or SearchSelectItemsEx function should be get using SearchGetStreetHandle function.

Type: Integer

#### StreetHandleB

A handle to the second street. The handle to a street found by SearchSelectItems or SearchSelectItemsEx function should be get using SearchGetStreetHandle function.

Type: Integer

### SearchAddStreetWithNumToSelection function.

Searches for the given building number on a street and adds it to session selection. Found position will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic coordinates of found point.

Module: SearchModule

Result type: TSoapSearchAddStreetWithNumToSelection__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### StreetNum

The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index. The element must be of kind "roads".

Type: Integer

#### Numeration

Building number to be found.

Type: WideString

### SearchGetCityList function.

Returns a part of list of cities found by SearchSelectCities function. In addition names and abbreviations of administrative regions are returned for each city.

Module: SearchModule

Result type: TSoapSearchGetCityList__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### First

A start index of requested part of the city list found and kept in the session search context. Value 0 is the first index.

Type: Integer

#### Count

Count of requested cities. Function returns at most 100 cities, so if the value is greater, length of resultant lists should be checked.

Type: Integer

### SearchGetCityListEx function.

Returns a part of list of cities found by SearchSelectCities function. In addition names and abbreviations of administrative regions are returned for each city.

Module: SearchModule

Result type: TSoapSearchGetCityListEx__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### First

A start index of requested part of the city list found and kept in the session search context. Value 0 is the first index.

Type: Integer

#### Count

Count of requested cities. Function returns at most 100 cities, so if the value is greater, length of resultant lists should be checked.

Type: Integer

### SearchGetCountryList function.

Returns a list of available countries. The first item of the list is empty - it is "any country" entry.

Module: SearchModule

Result type: TSoapSearchGetCountryList__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### SearchGetItemKindList function.

Returns a list of available kinds of searched map elements. The first item of the list is empty - it is "any element kind" entry.

Module: SearchModule

Result type: TSoapSearchGetItemKindList__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### SearchGetItemsList function.

Returns a part of list of map elements found by SearchSelectItems or SearchSelectItemsEx function. In addition indices of corresponding element kinds are returned for each element.

Module: SearchModule

Result type: TSoapSearchGetItemsList__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### First

A start index of requested part of the element list found and kept in the session search context. Value 0 is the first index.

Type: Integer

#### Count

Count of requested elements. Function returns at most 100 elements, so if the value is greater, length of resultant lists should be checked.

Type: Integer

### SearchGetParamValue function.

Returns a value for given parameter of searching stored in the session. List of all supported parameters may be obtained by SearchGetParamValues function.

Module: SearchModule

Result type: TSoapSearchGetParamValue__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ParamName

Parameter name.

Type: WideString

### SearchGetParamValues function.

Returns values for all parameters of searching stored in the session. Parameter value meanings:
* geocodeparams.firststreetwordpriority - street word priority:
- 0 = last word priority (default)
- 1 = first word priority
* geocodeparams.filteroutelems - a list of element kinds to be filtered out while geocoding (by default the list is empty). The list of available kinds can be obtained by SearchGetItemKindList function.
* geocodeparams.attachnumerationtostreet - the coordinates of numeration points are attached to streets:
- 0 = disabled (default)
- 1 = enabled

Module: SearchModule

Result type: TSoapSearchGetParamValues__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### SearchGetStreetHandle function.

Returns a global identifier (a handle) of a map element being of kind "roads". The handle is fixed for the server session, not only for session search context.

Module: SearchModule

Result type: TSoapSearchGetStreetHandle__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### StreetNum

The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index. The element must be of kind "roads".

Type: Integer

### SearchInitialize function.

Clears a search context in the given server session and initializes required search mode of the searching.
Returns value from error code table.

Module: SearchModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ASCIISearch

This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be used).

Type: Boolean

### SearchSelectCities function.

Searches for cities with names cantaining given prefix at the beginning of any word. Cities are searched in the given country. Postal code and administrative regions help in avoiding of ambiguity. The function returns only length of the resultant list. Found cities are kept in the session search context. Search process is case-insensitive.

Module: SearchModule

Result type: TSoapSearchSelectCities__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Country

The number of country being an index in the list returned by SearchGetCountryList function. Value 0 (the first index) corresponds to "any country".

Type: Integer

#### Prefix

A phrase being searched at the beginning of city names. The phrase may be empty to obtain all cities.

Type: WideString

#### ZIP

Postal code.

Type: WideString

#### Adm1

The name of 2nd level administrative area, i.e. a county.

Type: WideString

#### Adm2

The name of 3rd level administrative area, i.e. a district.

Type: WideString

#### Adm3

The name of 4th level administrative area.

Type: WideString

### SearchSelectItems function.

Searches for map elements of certain kind with names cantaining given prefix at the beginning of any word. Elements are searched in the given city. The function returns only length of the resultant list. Found elements are kept in the session search context. Search process is case-insensitive.

Module: SearchModule

Result type: TSoapSearchSelectItems__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### CityIndex

The number of city being an index in the list created in the session context by SearchSelectCities function. Value 0 is the first index.

Type: Integer

#### ItemKindIndex

The number of element kind being an index in the list returned by SearchGetItemKindList function. Value 0 (the first index) corresponds to "any element kind".

Type: Integer

#### Prefix

A phrase being searched at the beginning of any word of map element names. For elements of some kinds (rivers, lakes, cemeteries, parks) only begginings of whole names are matched. The phrase may be empty to obtain all elements.

Type: WideString

### SearchSelectItemsEx function.

Searches for map elements of certain kind with names cantaining given prefix at the beginning of any word. Elements are searched in the given country. The function returns only length of the resultant list. Found elements are kept in the session search context. Search process is case-insensitive.

Module: SearchModule

Result type: TSoapSearchSelectItemsEx__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Country

The number of country being an index in the list returned by SearchGetCountryList function. Value 0 (the first index) corresponds to "any country".

Type: Integer

#### ItemKindIndex

The number of element kind being an index in the list returned by SearchGetItemKindList function. Value 0 (the first index) corresponds to "any element kind".

Type: Integer

#### Prefix

A phrase being searched at the beginning of any word of map element names. For elements of some kinds (rivers, lakes, cemeteries, parks) only begginings of whole names are matched. The phrase may be empty to obtain all elements.

Type: WideString

### SearchSetItemsFilter function.

Set the list of map element kinds which are used requesting the SearchSelectItems or SearchSelectItemsEx functions with the ItemKindIndex parameter set to 0. By default all element kinds are used.
Returns value from error code table.

Module: SearchModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ItemKinds

The list of element kind indices (only indices returned by SearchGetItemKindList function are permitted).

Type: TDynamicIntegerArray

### SearchSetParamValue function.

Sets a value for given parameter of searching stored in the session. List of all supported parameters may be obtained by SearchGetParamValues function.
Returns value from error code table.

Module: SearchModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ParamName

Parameter name.

Type: WideString

#### ParamValue

Parameter value.

Type: WideString

### ServiceConfigGetServiceParams function.

Returns a service config param list. For future use.

Module: BaseModule

Result type: TSoapServiceConfigGetServiceParams__mcsResult

### ServiceConfigSetServiceParam function.

Sets a service config param. For future use.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### ParamName

Parameter name.

Type: WideString

#### ParamValue

Parameter value.

Type: WideString

### SetCurrentViewConfig function.

Sets current session view config.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ViewConfigName

View config name.

Type: WideString

### SetGroupBinaryData function.

Sets an arbitrary binary data for object group identified by given ID.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

#### BinaryData

Binary data.

Type: TByteDynArray

### SetGroupShapeSettings function.

Sets settings of an object group concerning shape visualization.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupID

Object group identifier.

Type: TRecordID

#### GroupShapeSettings

Visual shape settings of object group.

Type: TSoapTGroupShapeSettings

### SetObjectBinaryData function.

Sets an arbitrary binary data for object identified by given ID.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectID

Object identifier.

Type: TRecordID

#### BinaryData

Binary data.

Type: TByteDynArray

### SetObjectFields function.

Sets a new structure of an object set currently opened (requires administrative privileges). Any subset of data fileds can be changed. EditObjectFields should be invoked before.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### FieldNames

Names of object fields to be changed.

Type: TWideStringArray

#### FieldTypes

New types of corresponding object fields. Following values are supported:
- Character or string field = 0x01
- 16-bit integer field = 0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field = 0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
- Date field = 0x09
- Time field = 0x0A
- Date and time field = 0x0B

Type: TDynamicByteArray

#### FieldSize

New sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.

Type: TDynamicIntegerArray

#### FieldPrecision

New precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.

Type: TDynamicIntegerArray

#### FieldInfo

New parameters of corresponding object fields. It is a bit vector for each field - each bit deals with one parameter:
- key field = 0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
- indexed field = 0x08
- not null field (value required) = 0x10

Type: TDynamicByteArray

#### FieldFunctions

Specific features of corresponding object fields. Following values are supported:
- name (object name being drawn on maps) = 0x01
- city (for geocoding purposes) = 0x02
- street (for geocoding purposes) = 0x03
- number (for geocoding purposes) = 0x04
- postal code (for geocoding purposes) = 0x05
- break time (for routing purposes) = 0x0A
- country (for geocoding purposes) = 0x0F

Type: TDynamicByteArray

#### FieldNewNames

New names of corresponding object fields.

Type: TWideStringArray

### SetObjectIDs function.

Filters currently opened object set. Takes into account objects being results of previous filter performed by the server session on the object set. Function finds objects with given identifiers or objects, which haven't got given identifiers. The behaviour depends on value of AllowSelected parameter.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### ObjectIDs

Object identifier list.

Type: TWideStringArray

#### AllowSelected

Indicates whether given objects should be left (true) or filtered out (false).

Type: Boolean

### SetSessionComment function.

Sets session comment.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Comment

Session comment.

Type: WideString

### SetSessionLanguageContext function.

Sets session language context.
Returns value from error code table.

Module: BaseModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### ContextIndex

Context level (0-2).

Type: Integer

#### LanguageName

Language name.

Type: WideString

### SetVisibleGroups function.

Sets the visibility on maps for object groups.
Returns value from error code table.

Module: ObjectsModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### TableName

Table name.

Type: WideString

#### GroupIDs

A list of object group identifiers to be shown on maps. Other object groups in the object set will be hidden. The list of identifiers for all object groups in the object set may be obtained using GetObjectFields function.

Type: TWideStringArray

### VehicleRepositoryAddVehicle function.

Defines a new vehicle within the server session's vehicle repository.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Vehicle

A new vehicle parameters.

Type: TSoapTVehicleEntry

### VehicleRepositoryDriverParamsGet function.

Returns current driver parameters of one of the vehicles stored in the session's vehicle repository.

Module: RoutePlannerModule

Result type: TSoapVehicleRepositoryDriverParamsGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

### VehicleRepositoryDriverParamsSet function.

Sets new driver parameters for given vehicle stored in the repository replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

### VehicleRepositoryRemoveVehicle function.

Deletes one of the vehicles stored in the session's vehicle repository.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

### VehicleRepositoryRoadParamsGet function.

Returns current road parameters of one of the vehicles stored in the session's vehicle repository.

Module: RoutePlannerModule

Result type: TSoapVehicleRepositoryRoadParamsGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

### VehicleRepositoryRoadParamsSet function.

Sets new road parameters for given vehicle stored in the repository replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

### VehicleRepositoryVehicleFetch function.

Fetches existing vehicle with all its parameters from the repository. The vehicle and its road parameters become current session parameters for routing.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

### VehicleRepositoryVehicleGet function.

Returns parameters of one of the vehicles stored in the session's vehicle repository.

Module: RoutePlannerModule

Result type: TSoapVehicleRepositoryVehicleGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

### VehicleRepositoryVehicleReplace function.

Raplaces all parameters of one of the vehicle in the repository with current vehicle and road parameters stored in the session.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

### VehicleRepositoryVehiclesClear function.

Deletes all vehicles stored in the session's vehicle repository.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### VehicleRepositoryVehicleSet function.

Sets new vehicle parameters in the session's vehicle repository replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

#### Vehicle

New parameters of the vehicle.

Type: TSoapTVehicleEntry

### VehicleRepositoryVehiclesGet function.

Returns a list of all vehicles stored in the session's vehicle repository.

Module: RoutePlannerModule

Result type: TSoapVehicleRepositoryVehiclesGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

### VehicleRepositoryVehiclesSet function.

Sets a new set of vehicles in the vehicle repository.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### Vehicles

New list of vehicles.

Type: TSoapTVehicleEntryArray

### VehicleRepositoryVehicleViaTollGet function.

Returns current viaTOLL parameters of one of the vehicles stored in the session's vehicle repository.

Module: RoutePlannerModule

Result type: TSoapVehicleRepositoryVehicleViaTollGet__mcsResult

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

### VehicleRepositoryVehicleViaTollSet function.

Sets new viaTOLL parameters for given vehicle stored in the repository replacing present parameters.
Returns value from error code table.

Module: RoutePlannerModule

Result type: Integer

Parameters:

#### SessionID

Session identifier.

Type: TSessionID

#### VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Type: Integer

#### ViaTollParams

New parameters of the vehicle.

Type: TSoapTRoadViaTollParamsArray

### TCaptionPosition type.

Mapped to: Byte

### TColor type.

Mapped to: Integer

### TConnectionString type.

Mapped to: WideString

### TGeocodeStatus type.

Mapped to: Byte

### TRecordID type.

Mapped to: Integer

### TSessionID type.

Unique server session identifier.

Mapped to: WideString

### TUID type.

Mapped to: WideString

### TBlobArray type.

Base type: TByteDynArray

### TBooleanArray type.

Base type: Boolean

### TByteArray type.

Base type: Byte

### TCaptionPositionArray type.

Base type: TCaptionPosition

### TDynamicByteArray type.

Base type: Byte

### TDynamicIntegerArray type.

Base type: Integer

### TFloatArray type.

Base type: Double

### TSoapTBooleanArrayArray type.

Base type: TBooleanArray

### TSoapTDegeocodeAtPointDatabaseResultArray type.

Base type: TSoapTDegeocodeAtPointDatabaseResult

### TSoapTDegeocodeAtPointResultArray type.

Base type: TSoapTDegeocodeAtPointResult

### TSoapTDegeocodeCityElementResultArray type.

Base type: TSoapTDegeocodeCityElementResult

### TSoapTDegeocodeExResultEntryArray type.

Base type: TSoapTDegeocodeExResultEntry

### TSoapTDegeocodeResultArray type.

Base type: TSoapTDegeocodeResult

### TSoapTDegeocodeRoadElementResultArray type.

Base type: TSoapTDegeocodeRoadElementResult

### TSoapTDriveThroughArray type.

Base type: TSoapTDriveThrough

### TSoapTFloatArrayArray type.

Base type: TFloatArray

### TSoapTGeocodePointInfoArray type.

Base type: TSoapTGeocodePointInfo

### TSoapTGeocodePointInfoExArray type.

Base type: TSoapTGeocodePointInfoEx

### TSoapTIconPropertiesArray type.

Base type: TSoapTIconProperties

### TSoapTLocalizeObjectPositionDataArray type.

Base type: TSoapTLocalizeObjectPositionData

### TSoapTLogisticTOLLResultsArray type.

Base type: TSoapTLogisticTOLLResults

### TSoapTLongLatPoint2DArray type.

Base type: TSoapTLongLatPointArray

### TSoapTLongLatPointArray type.

Base type: TSoapTLongLatPoint

### TSoapTLongLatRectArray type.

Base type: TSoapTLongLatRect

### TSoapTMapFileEntryArray type.

Base type: TSoapTMapFileEntry

### TSoapTMultiGeocodePointInfoExArray type.

Base type: TSoapTMultiGeocodePointInfoEx

### TSoapTObjectPositionArray type.

Base type: TSoapTObjectPosition

### TSoapTPointsArray type.

Base type: TSoapTPoint

### TSoapTRectsArray type.

Base type: TSoapTRect

### TSoapTRepositoryRouteArray type.

Base type: TSoapTRepositoryRoute

### TSoapTRoadParamsArray type.

Base type: TSoapTRoadParams

### TSoapTRoadResultsArray type.

Base type: TSoapTRoadResults

### TSoapTRoadViaTollParamsArray type.

Base type: TSoapTRoadViaTollParams

### TSoapTRouteAttributeParamsArray type.

Base type: TSoapTRouteAttributeParams

### TSoapTRouteAttributePassedArray type.

Base type: TSoapTRouteAttributePassedElem

### TSoapTRouteItineraryArray type.

Base type: TSoapTRouteItinerary

### TSoapTRouteOptimalizationEntryArray type.

Base type: TSoapTRouteOptimalizationEntry

### TSoapTRouteOptimizerEntry2Array type.

Base type: TSoapTRouteOptimizerEntry2

### TSoapTRouteOptimizerEntryAction2Array type.

Base type: TSoapTRouteOptimizerEntryAction2

### TSoapTRouteOptimizerEntryArray type.

Base type: TSoapTRouteOptimizerEntry

### TSoapTRouteOptimizerResultRoutesArray type.

Base type: TSoapTRouteOptimizerResultRoutesEntry

### TSoapTRouteOptimizerShipmentActionArray type.

Base type: TSoapTRouteOptimizerShipmentAction

### TSoapTRouteOptimizerShipmentMovesArray type.

Base type: TSoapTRouteOptimizerShipmentMove

### TSoapTSessionEnumArray type.

Base type: TSoapTSessionEnumEntry

### TSoapTShipmentsArray type.

Base type: TSoapTShipment

### TSoapTShipmentTypeToShipmentTypeIncompatibilityArray type.

Base type: TSoapTShipmentTypeToShipmentTypeIncompatibility

### TSoapTTimeWindowsArray type.

Base type: TSoapTTimeWindow

### TSoapTVehicleCategoryToShipmentTypeIncompatibilityArray type.

Base type: TSoapTVehicleCategoryToShipmentTypeIncompatibility

### TSoapTVehicleEntryArray type.

Base type: TSoapTVehicleEntry

### TSoapTViaTollRoadResultsArray type.

Base type: TSoapTViaTollRoadResults

### TSoapTViewConfigListArray type.

Base type: TSoapTViewConfigEntry

### TSoapTWideStringArrayArray type.

Base type: TWideStringArray

### TWideStringArray type.

Base type: WideString

### TSoapAddGroupIcon__mcsResult class.

Encapsulates all output values for AddGroupIcon function

Properties:

#### NewIconID

Identifier of an icon added.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapAppendGroup__mcsResult class.

Encapsulates all output values for AppendGroup function

Properties:

#### NewGroupID

Identifier of a new object group.

Type: TRecordID

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapAppendObject__mcsResult class.

Encapsulates all output values for AppendObject function

Properties:

#### NewObjectID

An identifier of the new object.

Type: TRecordID

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapAppendObjects__mcsResult class.

Encapsulates all output values for AppendObjects function

Properties:

#### NewObjectIDs

A list of identifiers of the new objects.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapAuthGetGroup__mcsResult class.

Encapsulates all output values for AuthGetGroup function

Properties:

#### GroupComment

User group comment.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapAuthGetGroupsList__mcsResult class.

Encapsulates all output values for AuthGetGroupsList function

Properties:

#### GroupsList

A list of user group names.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapAuthGetUserParamEx__mcsResult class.

Encapsulates all output values for AuthGetUserParamEx function

Properties:

#### ParamValue

Parameter value.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapAuthGetUserParams__mcsResult class.

Encapsulates all output values for AuthGetUserParams function

Properties:

#### Comment

Comment.

Type: WideString

#### AccountEnabled

Option of account enabling.

Type: Boolean

#### Groups

A list of user groups the account belongs to.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapAuthGetUsersList__mcsResult class.

Encapsulates all output values for AuthGetUsersList function

Properties:

#### UsersList

A list of user names.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapCheckUpdate__mcsResult class.

Encapsulates all output values for CheckUpdate function

Properties:

#### ModifiedObjectCount

Number of objects changed. A list of them may be obtained using GetNextResult_UpdatedSet function.

Type: Integer

#### RemovedObjectCount

Number of objects removed. A list of them may be obtained using GetNextResult_RemovedSet function.

Type: Integer

#### ModifiedGroups

Identifiers of changed object groups.

Type: TDynamicIntegerArray

#### ModifiedIcons

Indicates whether a list of icons stored into database was changed.

Type: Boolean

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapConvertMapToScreen__mcsResult class.

Encapsulates all output values for ConvertMapToScreen function

Properties:

#### ScreenPoints

The resultant list of screen points. Their coordinates may be negative or higher than given image sizes.

Type: TSoapTPointsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapConvertScreenToMap__mcsResult class.

Encapsulates all output values for ConvertScreenToMap function

Properties:

#### MapPoints

The resultant list of geographic points.

Type: TSoapTLongLatPointArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapCreateSessionID__mcsResult class.

Encapsulates all output values for CreateSessionID function

Properties:

#### SessionID

Identifier of created session.

Type: TSessionID

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapDegeocode__mcsResult class.

Encapsulates all output values for Degeocode function

Properties:

#### Results

The list of geographic information entries.

Type: TSoapTDegeocodeResultArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapDegeocodeAtPoint__mcsResult class.

Encapsulates all output values for DegeocodeAtPoint function

Properties:

#### AreaName0

Country name.

Type: WideString

#### AreaName1

The name of 2nd level administrative area, i.e. a county.

Type: WideString

#### AreaName2

The name of 3rd level administrative area, i.e. a district.

Type: WideString

#### AreaName3

The name of 4th level administrative area.

Type: WideString

#### City

The list of found cities.

Type: TSoapTDegeocodeCityElementResultArray

#### Zip

Postal code.

Type: WideString

#### Road

The list of roads found.

Type: TSoapTDegeocodeRoadElementResultArray

#### InternationalRoad

The list of international roads found.

Type: TSoapTDegeocodeRoadElementResultArray

#### Street

The list of streets found.

Type: TSoapTDegeocodeRoadElementResultArray

#### Natural

The list of topographic objects found.

Type: TSoapTDegeocodeAtPointResultArray

#### OtherMapElements

The list of other map elements found.

Type: TSoapTDegeocodeAtPointResultArray

#### DatabaseElements

The list of external objects found (saved in the session and placed on a map).

Type: TSoapTDegeocodeAtPointDatabaseResultArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapDegeocodeEx__mcsResult class.

Encapsulates all output values for DegeocodeEx function

Properties:

#### Results

The list of geographic information entries.

Type: TSoapTDegeocodeResultArray

#### OtherElements

The list of other elements found.

Type: TSoapTDegeocodeExResultEntryArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapDegeocodeExWithAttributes__mcsResult class.

Encapsulates all output values for DegeocodeExWithAttributes function

Properties:

#### Results

The list of geographic information entries.

Type: TSoapTDegeocodeResultArray

#### OtherElements

The list of other elements found.

Type: TSoapTDegeocodeExResultEntryArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapDegeocodeGetParamValue__mcsResult class.

Encapsulates all output values for DegeocodeGetParamValue function

Properties:

#### ParamValue

Parameter value.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapDeleteObjects__mcsResult class.

Encapsulates all output values for DeleteObjects function

Properties:

#### NotDeletedIDs

A list of not deleted objects (locked by other users or not existing).

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapFilterByObjectShape__mcsResult class.

Encapsulates all output values for FilterByObjectShape function

Properties:

#### Count

Count of objects found.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapFilterByPoint__mcsResult class.

Encapsulates all output values for FilterByPoint function

Properties:

#### Count

Count of objects found.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapFilterByRadius__mcsResult class.

Encapsulates all output values for FilterByRadius function

Properties:

#### Count

Count of objects found.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapFilterByShape__mcsResult class.

Encapsulates all output values for FilterByShape function

Properties:

#### Count

Count of objects found.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapFilterByText__mcsResult class.

Encapsulates all output values for FilterByText function

Properties:

#### Count

Count of objects found.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapForwardCalc__mcsResult class.

Encapsulates all output values for ForwardCalc function

Properties:

#### StopPoint

Geographic coordinates of the resultant stop point.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGeocode__mcsResult class.

Encapsulates all output values for Geocode function

Properties:

#### GeocodeLevel

A list of resultant geocode levels. The geocode level is a bit vector - each bit deals with one address item:
- country = 0x01
- 2nd level administrative area (county) = 0x02
- 3rd level administrative area (district) = 0x04
- city = 0x08
- postal code = 0x10
- street = 0x20
- building numeration = 0x40
If an address item was taken into account while geocoding process, its bit is set to 1. If an address was not geocoded, the geocode level for it has value 0 (all bits set to 0).

Type: TDynamicByteArray

#### Positions

A list of resultant geographic coordinates.

Type: TSoapTLongLatPointArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGeocodeEx__mcsResult class.

Encapsulates all output values for GeocodeEx function

Properties:

#### Points

Proposed resultant addresses.

Type: TSoapTGeocodePointInfoExArray

#### GeocodeLevel

A list of resultant geocode levels for proposals found. The geocode level is a bit vector - each bit deals with one address item:
- country = 0x01
- 2nd level administrative area (county) = 0x02
- 3rd level administrative area (district) = 0x04
- city = 0x08
- postal code = 0x10
- street = 0x20
- building numeration = 0x40
- 4rd level administrative area (commune) = 0x80
If an address item was taken into account while geocoding process, its bit is set to 1. If an address was not geocoded, the geocode level for it has value 0 (all bits set to 0).

Type: TDynamicByteArray

#### Positions

A list of resultant geographic coordinates.

Type: TSoapTLongLatPointArray

#### BoundingRects

Geographic coordinates of the rectangles bounding objects found.

Type: TSoapTLongLatRectArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetActiveSessions__mcsResult class.

Encapsulates all output values for GetActiveSessions function

Properties:

#### Sessions

Resultant statistic information.

Type: TSoapTSessionEnumArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetAggregatedObjects__mcsResult class.

Encapsulates all output values for GetAggregatedObjects function

Properties:

#### AggregatedIDs

Resultant object identifiers.

Type: TSoapTWideStringArrayArray

#### Aggregated

A list of informations of object aggregation possibility - whether given objects have got any shapes tied with them (in case of an empty list of identifiers returned for some object, to distinguish between objects without shapes and objects with shapes but without objects contained).

Type: TBooleanArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetAggregatedObjectShapes__mcsResult class.

Encapsulates all output values for GetAggregatedObjectShapes function

Properties:

#### AggregatedIDs

Resultant object identifiers.

Type: TSoapTWideStringArrayArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetAvailableIconFormats__mcsResult class.

Encapsulates all output values for GetAvailableIconFormats function

Properties:

#### IconFormats

The list of formats.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetAvailableImageFormats__mcsResult class.

Encapsulates all output values for GetAvailableImageFormats function

Properties:

#### ImageFormats

The list of formats.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetAvailableMapFiles__mcsResult class.

Encapsulates all output values for GetAvailableMapFiles function

Properties:

#### MapFiles

The list of map files.

Type: TSoapTMapFileEntryArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetCurrentSessionCount__mcsResult class.

Encapsulates all output values for GetCurrentSessionCount function

Properties:

#### SessionCount

Resultant number of sessions.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetCurrentViewConfig__mcsResult class.

Encapsulates all output values for GetCurrentViewConfig function

Properties:

#### ViewConfigName

Current view config name.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetDatabaseList__mcsResult class.

Encapsulates all output values for GetDatabaseList function

Properties:

#### DatabaseList

A list of available databases.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetDatabaseTableList__mcsResult class.

Encapsulates all output values for GetDatabaseTableList function

Properties:

#### DatabaseTableList

A list of tables.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetDefaultLayers__mcsResult class.

Encapsulates all output values for GetDefaultLayers function

Properties:

#### MapLayers

The list of layers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetDegeocodeLayers__mcsResult class.

Encapsulates all output values for GetDegeocodeLayers function

Properties:

#### DegeocodeLayers

The list of layers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetGroupBinaryData__mcsResult class.

Encapsulates all output values for GetGroupBinaryData function

Properties:

#### BinaryData

Binary data.

Type: TByteDynArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetGroupIcon__mcsResult class.

Encapsulates all output values for GetGroupIcon function

Properties:

#### GroupIcon

Resultant icon transferred as a byte stream.

Type: TByteDynArray

#### GroupIconProperties

Icon properties.

Type: TSoapTIconProperties

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetGroupIcons__mcsResult class.

Encapsulates all output values for GetGroupIcons function

Properties:

#### GroupIcons

A list of object group icon bitmaps transferred as byte streams.

Type: TBlobArray

#### GroupIconsProperties

Properties of object group icons.

Type: TSoapTIconPropertiesArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetGroupSettings__mcsResult class.

Encapsulates all output values for GetGroupSettings function

Properties:

#### GroupSettings

Visual settings of an object group.

Type: TSoapTGroupSettings

#### VisibleFields

Names of fields essential for an object group - other fields in object set are not important for the object group.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetGroupShapeSettings__mcsResult class.

Encapsulates all output values for GetGroupShapeSettings function

Properties:

#### GroupShapeSettings

Visual shape settings of object group.

Type: TSoapTGroupShapeSettings

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetLoadedMapsRegion__mcsResult class.

Encapsulates all output values for GetLoadedMapsRegion function

Properties:

#### CurrentMapSize

Resultant region.

Type: TSoapTLongLatRect

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetMapModules__mcsResult class.

Encapsulates all output values for GetMapModules function

Properties:

#### Modules

The list of server modules.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetMapPointLength__mcsResult class.

Encapsulates all output values for GetMapPointLength function

Properties:

#### Distance

Resultant distance (in meters).

Type: Double

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetMaxSessionsCount__mcsResult class.

Encapsulates all output values for GetMaxSessionsCount function

Properties:

#### SessionCount

Resultant number of sessions.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetModifiedFields__mcsResult class.

Encapsulates all output values for GetModifiedFields function

Properties:

#### FieldNames

A list of field names.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetNextResult_FieldSet__mcsResult class.

Encapsulates all output values for GetNextResult_FieldSet function

Properties:

#### FieldValues

Resultant field values.

Type: TWideStringArray

#### NotFoundIDs

List of identifiers of objects missed.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetNextResult_IDSet__mcsResult class.

Encapsulates all output values for GetNextResult_IDSet function

Properties:

#### ObjectIDs

Resultant object identifiers.

Type: TWideStringArray

#### GroupIDs

Resultant object group identifiers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetNextResult_PositionSet__mcsResult class.

Encapsulates all output values for GetNextResult_PositionSet function

Properties:

#### ObjectPositions

Geographic information for requested objects.

Type: TSoapTObjectPositionArray

#### CaptionPositions

Positions of object names being drawn on maps nearby its icons. The position is the alignment of object name with reference to its icon. Supported values are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07

Type: TCaptionPositionArray

#### NotFoundIDs

List of identifiers of objects missed.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetNextResult_RemovedSet__mcsResult class.

Encapsulates all output values for GetNextResult_RemovedSet function

Properties:

#### ObjectIDs

Resultant object identifiers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetNextResult_Set__mcsResult class.

Encapsulates all output values for GetNextResult_Set function

Properties:

#### ObjectIDs

Resultant object identifiers.

Type: TWideStringArray

#### GroupIDs

Resultant object group identifiers.

Type: TWideStringArray

#### ObjectPositions

Geographic information for requested objects.

Type: TSoapTObjectPositionArray

#### CaptionPositions

Positions of object names being drawn on maps nearby its icons. The position is the alignment of object name with reference to its icon. Supported values are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07

Type: TCaptionPositionArray

#### FieldValuesArray

Resultant field values.

Type: TSoapTWideStringArrayArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetNextResult_UpdatedSet__mcsResult class.

Encapsulates all output values for GetNextResult_UpdatedSet function

Properties:

#### ObjectIDs

Resultant object identifiers.

Type: TWideStringArray

#### GroupIDs

Resultant object group identifiers.

Type: TWideStringArray

#### ObjectPositions

Geographic information for requested objects.

Type: TSoapTObjectPositionArray

#### CaptionPositions

Positions of object names being drawn on maps nearby its icons. The position is the alignment of object name with reference to its icon. Supported values are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07

Type: TCaptionPositionArray

#### FieldValuesArray

Resultant field values.

Type: TSoapTWideStringArrayArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObject__mcsResult class.

Encapsulates all output values for GetObject function

Properties:

#### FieldValues

Values for requested object fields.

Type: TWideStringArray

#### ObjectPosition

Object geographic data.

Type: TSoapTObjectPosition

#### CaptionPosition

Position of object name being drawn on maps nearby its icon. It is the alignment of object name with reference to its icon. Supported values are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07

Type: TCaptionPosition

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectAggregates__mcsResult class.

Encapsulates all output values for GetObjectAggregates function

Properties:

#### FieldSum

A list of sum values for requested fields. Empty strings are returned for non-numeric fields.

Type: TWideStringArray

#### FieldMin

A list of minimal values for requested fields.

Type: TWideStringArray

#### FieldMax

A list of maximal values for requested fields.

Type: TWideStringArray

#### FieldAvg

A list of average values for requested fields. Empty strings are returned for non-numeric fields.

Type: TWideStringArray

#### FieldNull

A list of empty value counters for requested fields.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectBinaryData__mcsResult class.

Encapsulates all output values for GetObjectBinaryData function

Properties:

#### BinaryData

Binary data.

Type: TByteDynArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectCircles__mcsResult class.

Encapsulates all output values for GetObjectCircles function

Properties:

#### MapPointArray

Geographical coordinates of middle points.

Type: TSoapTLongLatPointArray

#### MapRadiusArray

Circle radiuses (in meters).

Type: TFloatArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectCount__mcsResult class.

Encapsulates all output values for GetObjectCount function

Properties:

#### RecordCount

A count of objects available.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectEllipses__mcsResult class.

Encapsulates all output values for GetObjectEllipses function

Properties:

#### MapRects

Geographical coordinates of a bounding rectangle of ellipses.

Type: TSoapTLongLatRectArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectFields__mcsResult class.

Encapsulates all output values for GetObjectFields function

Properties:

#### FieldNames

Names of object fields.

Type: TWideStringArray

#### FieldTypes

Types of corresponding object fields. Following values are supported:
- Character or string field = 0x01
- 16-bit integer field = 0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field = 0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
- Date field = 0x09
- Time field = 0x0A
- Date and time field = 0x0B

Type: TDynamicByteArray

#### FieldSize

Sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.

Type: TDynamicIntegerArray

#### FieldPrecision

Precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.

Type: TDynamicIntegerArray

#### FieldInfo

Parameters of corresponding object fields. It is a bit vector for each field - each bit deals with one parameter:
- key field = 0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
- indexed field = 0x08
- not null field (value required) = 0x10

Type: TDynamicByteArray

#### FieldFunctions

Specific features of corresponding object fields. Following values are supported:
- name (object name being drawn on maps) = 0x01
- city (for geocoding purposes) = 0x02
- street (for geocoding purposes) = 0x03
- number (for geocoding purposes) = 0x04
- postal code (for geocoding purposes) = 0x05
- break time (for routing purposes) = 0x0A
- country (for geocoding purposes) = 0x0F

Type: TDynamicByteArray

#### GroupIDs

A list of unique identifiers of all object groups in the object set.

Type: TWideStringArray

#### GroupNames

A list of names of all object groups in the object set.

Type: TWideStringArray

#### GroupIcons

A list of object group icon bitmaps transferred as byte streams.

Type: TBlobArray

#### GroupIconsProperties

Properties of object group icons.

Type: TSoapTIconPropertiesArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectPolygons__mcsResult class.

Encapsulates all output values for GetObjectPolygons function

Properties:

#### MapPoints

Geographical coordinates of vertices of polygons.

Type: TSoapTLongLatPoint2DArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectPolylines__mcsResult class.

Encapsulates all output values for GetObjectPolylines function

Properties:

#### MapPoints

Geographical coordinates of vertices of polygons.

Type: TSoapTLongLatPoint2DArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetObjectRectangles__mcsResult class.

Encapsulates all output values for GetObjectRectangles function

Properties:

#### MapRects

Geographical coordinates of rectangles.

Type: TSoapTLongLatRectArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetProjections__mcsResult class.

Encapsulates all output values for GetProjections function

Properties:

#### Projections

The list of projections.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetRemovedFields__mcsResult class.

Encapsulates all output values for GetRemovedFields function

Properties:

#### FieldNames

A list of field names.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetScreenPointLength__mcsResult class.

Encapsulates all output values for GetScreenPointLength function

Properties:

#### Distance

Resultant distance (in meters).

Type: Double

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetServerVersion__mcsResult class.

Encapsulates all output values for GetServerVersion function

Properties:

#### ServerVersion

Server version.

Type: WideString

#### DataCompilationDate

The list of versions of subsequent data components.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetSessionComment__mcsResult class.

Encapsulates all output values for GetSessionComment function

Properties:

#### Comment

Session comment.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetSessionLanguageContext__mcsResult class.

Encapsulates all output values for GetSessionLanguageContext function

Properties:

#### LanguageName

Language name.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetSessionLifetimeSeconds__mcsResult class.

Encapsulates all output values for GetSessionLifetimeSeconds function

Properties:

#### SessionLifetime

Resultant time.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetTiledMapLayers__mcsResult class.

Encapsulates all output values for GetTiledMapLayers function

Properties:

#### TiledMapLayers

The list of layers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetViewConfigList__mcsResult class.

Encapsulates all output values for GetViewConfigList function

Properties:

#### ViewConfigList

A list of view configs.

Type: TSoapTViewConfigListArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapGetVisibleGroups__mcsResult class.

Encapsulates all output values for GetVisibleGroups function

Properties:

#### GroupIDs

A list of object group identifiers currently shown on maps.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapInverseCalc__mcsResult class.

Encapsulates all output values for InverseCalc function

Properties:

#### Length

Resultant distance (in meters).

Type: Double

#### Azimuth12

Resultant azimuth from the start to the stop point. It is an angle in degrees between 0 and 360 counterclockwise.

Type: Double

#### Azimuth21

Resultant azimuth from the stop to the start point. It is an angle in degrees between 0 and 360 counterclockwise.

Type: Double

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeGetObjectVisibility__mcsResult class.

Encapsulates all output values for LocalizeGetObjectVisibility function

Properties:

#### ObjectVisibility

A list of localized objects visibility informations. Length of the list equals the number of objects in the localized objects collection.

Type: TBooleanArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeIconGet__mcsResult class.

Encapsulates all output values for LocalizeIconGet function

Properties:

#### IconInfo

Icon properties.

Type: TSoapTIconProperties

#### IconData

An icon transferred as a byte stream.

Type: TByteDynArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeIconGetCount__mcsResult class.

Encapsulates all output values for LocalizeIconGetCount function

Properties:

#### Count

The number of icons in a collection.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeIconIDToItemIndex__mcsResult class.

Encapsulates all output values for LocalizeIconIDToItemIndex function

Properties:

#### ItemIndex

Index of an icon in the collection. It is a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeNumFieldsGet__mcsResult class.

Encapsulates all output values for LocalizeNumFieldsGet function

Properties:

#### Name

Field name.

Type: WideString

#### ShowOnInfo

Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.

Type: Boolean

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeNumFieldsGetCount__mcsResult class.

Encapsulates all output values for LocalizeNumFieldsGetCount function

Properties:

#### Count

The number of fields in a collection.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeObjectEntityIDToItemIndex__mcsResult class.

Encapsulates all output values for LocalizeObjectEntityIDToItemIndex function

Properties:

#### ItemIndex

Index of an object in the collection. It is a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeObjectGet__mcsResult class.

Encapsulates all output values for LocalizeObjectGet function

Properties:

#### EntityID

The unique object identifier.

Type: Integer

#### Name

Object name displayed by the last position of an object on the map, providing the ShowName option is active.

Type: WideString

#### ShowName

Information on whether to display the name by the last position of an object on the map.

Type: Boolean

#### IconID

A unique identifier of icon saved in the icons collection in the server session.

Type: Integer

#### ShowIcon

Information on whether to display the icon by the last position of an object on the map.

Type: Boolean

#### IconColor

The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It is a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### PathColor

The color of the track created by the object positions. It is a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### PathWidth

The width of the track created by the object positions (measured in pixels).

Type: Integer

#### Size

The size of the position marker in the track, measured in pixels.

Type: Integer

#### RemovePreviousPositions

Information on whether to delete the previous object positions while localizing new positions of the object.

Type: Boolean

#### PointsConnected

Information on whether to connect the object positions into a track.

Type: Boolean

#### FontParams

A font of object name displayed on maps.

Type: TSoapTFontParameters

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeObjectGetCount__mcsResult class.

Encapsulates all output values for LocalizeObjectGetCount function

Properties:

#### Count

The number of objects in a collection.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeObjectPositionGet__mcsResult class.

Encapsulates all output values for LocalizeObjectPositionGet function

Properties:

#### NumFields

Values of all numeric fields contained in the collection saved in the server session.

Type: TFloatArray

#### StrFields

Values of all string fields contained in the collection saved in the server session.

Type: TWideStringArray

#### PositionPoint

Geographic coordinates of the position point.

Type: TSoapTLongLatPoint

#### Time

Time (in the GMT time zone) of the position (number of days since 30-12-1899 12:00 AM).

Type: Double

#### Description

The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.

Type: WideString

#### ShowDescription

Information on whether to display the description of the position of the object on the map.

Type: Boolean

#### ShowName

Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).

Type: Boolean

#### IconID

A unique identifier of icon saved in the icons collection in the server session.

Type: Integer

#### ShowIcon

Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).

Type: Boolean

#### IconColor

The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It is a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### FontParams

A font of position description displayed on maps.

Type: TSoapTFontParameters

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeObjectPositionGetCount__mcsResult class.

Encapsulates all output values for LocalizeObjectPositionGetCount function

Properties:

#### Count

The number of object positions of the localized object.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeStrFieldsGet__mcsResult class.

Encapsulates all output values for LocalizeStrFieldsGet function

Properties:

#### Name

Field name.

Type: WideString

#### ShowOnInfo

Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.

Type: Boolean

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapLocalizeStrFieldsGetCount__mcsResult class.

Encapsulates all output values for LocalizeStrFieldsGetCount function

Properties:

#### Count

The number of fields in a collection.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapMapBaseConnect__mcsResult class.

Encapsulates all output values for MapBaseConnect function

Properties:

#### AccessLevel

Indicates whether logged user has permissions to change data (0 = administrative privileges, 1 = editing, 2 = read only access).

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapMapBaseStoreToBlob__mcsResult class.

Encapsulates all output values for MapBaseStoreToBlob function

Properties:

#### BinaryData

A database content.

Type: TByteDynArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapMultiGeocodeEx__mcsResult class.

Encapsulates all output values for MultiGeocodeEx function

Properties:

#### OutputPoints

Proposed resultant addresses.

Type: TSoapTMultiGeocodePointInfoExArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapPostObjects__mcsResult class.

Encapsulates all output values for PostObjects function

Properties:

#### NotPostedIDs

A list of not posted objects (locked by other users or not existing).

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderMapOnHWNDByPoint__mcsResult class.

Encapsulates all output values for RenderMapOnHWNDByPoint function

Properties:

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderMapOnHWNDByPointWithCopyright__mcsResult class.

Encapsulates all output values for RenderMapOnHWNDByPointWithCopyright function

Properties:

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### Copyrights

Copyrights of used map providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderMapOnHWNDByRect__mcsResult class.

Encapsulates all output values for RenderMapOnHWNDByRect function

Properties:

#### MiddlePoint

Geographic coordinates of middle point of the resultant map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

Type: Double

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderMapOnHWNDByRectWithCopyright__mcsResult class.

Encapsulates all output values for RenderMapOnHWNDByRectWithCopyright function

Properties:

#### MiddlePoint

Geographic coordinates of middle point of the resultant map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

Type: Double

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### Copyrights

Copyrights of used map providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderMapOnImageByPoint__mcsResult class.

Encapsulates all output values for RenderMapOnImageByPoint function

Properties:

#### BitmapImage

The resultant image transferred as a byte stream.

Type: TByteDynArray

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderMapOnImageByPointWithCopyright__mcsResult class.

Encapsulates all output values for RenderMapOnImageByPointWithCopyright function

Properties:

#### BitmapImage

The resultant image transferred as a byte stream.

Type: TByteDynArray

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### Copyrights

Copyrights of used map providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderMapOnImageByRect__mcsResult class.

Encapsulates all output values for RenderMapOnImageByRect function

Properties:

#### BitmapImage

The resultant image transferred as a byte stream.

Type: TByteDynArray

#### MiddlePoint

Geographic coordinates of middle point of the resultant map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

Type: Double

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderMapOnImageByRectWithCopyright__mcsResult class.

Encapsulates all output values for RenderMapOnImageByRectWithCopyright function

Properties:

#### BitmapImage

The resultant image transferred as a byte stream.

Type: TByteDynArray

#### MiddlePoint

Geographic coordinates of middle point of the resultant map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

Type: Double

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### Copyrights

Copyrights of used map providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderSplitMapOnImageByPoint__mcsResult class.

Encapsulates all output values for RenderSplitMapOnImageByPoint function

Properties:

#### BitmapImage

List of resultant images transferred as a byte stream.

Type: TBlobArray

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderSplitMapOnImageByPointWithCopyright__mcsResult class.

Encapsulates all output values for RenderSplitMapOnImageByPointWithCopyright function

Properties:

#### BitmapImage

List of resultant images transferred as a byte stream.

Type: TBlobArray

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### Copyrights

Copyrights of used map providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderSplitMapOnImageByRect__mcsResult class.

Encapsulates all output values for RenderSplitMapOnImageByRect function

Properties:

#### BitmapImage

List of resultant images transferred as a byte stream.

Type: TBlobArray

#### MiddlePoint

Geographic coordinates of middle point of the resultant map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

Type: Double

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderSplitMapOnImageByRectWithCopyright__mcsResult class.

Encapsulates all output values for RenderSplitMapOnImageByRectWithCopyright function

Properties:

#### BitmapImage

List of resultant images transferred as a byte stream.

Type: TBlobArray

#### MiddlePoint

Geographic coordinates of middle point of the resultant map.

Type: TSoapTLongLatPoint

#### MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

Type: Double

#### BitmapRightUpCorner

Geographic coordinates of right-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapRightDownCorner

Geographic coordinates of right-down point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftUpCorner

Geographic coordinates of left-up point of the resultant map.

Type: TSoapTLongLatPoint

#### BitmapLeftDownCorner

Geographic coordinates of left-down point of the resultant map.

Type: TSoapTLongLatPoint

#### Copyrights

Copyrights of used map providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderTiledMap__mcsResult class.

Encapsulates all output values for RenderTiledMap function

Properties:

#### BitmapImages

List of resultant images transferred as a byte stream.

Type: TBlobArray

#### TilesX

X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.

Type: Integer

#### TilesY

Y-dimension (number of columns) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderTiledMapEx__mcsResult class.

Encapsulates all output values for RenderTiledMapEx function

Properties:

#### BitmapImagesPresent

List of presence of subseqent images within the resultant images.

Type: TBooleanArray

#### BitmapImages

List of resultant images transferred as a byte stream.

Type: TBlobArray

#### TilesX

X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.

Type: Integer

#### TilesY

Y-dimension (number of columns) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.

Type: Integer

#### Copyrights

Copyrights of used map providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRenderTiledMapWithCopyright__mcsResult class.

Encapsulates all output values for RenderTiledMapWithCopyright function

Properties:

#### BitmapImages

List of resultant images transferred as a byte stream.

Type: TBlobArray

#### TilesX

X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.

Type: Integer

#### TilesY

Y-dimension (number of columns) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.

Type: Integer

#### Copyrights

Copyrights of used map providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesAddAlongRouteAttribute__mcsResult class.

Encapsulates all output values for RouteAttributesAddAlongRouteAttribute function

Properties:

#### AttributeID

Auto-generated difficulty identifier. Essential if GenerateID option was set to true.

Type: Integer

#### Representation

All points of generated polyline (if ReturnRepresentation option was set to true).

Type: TSoapTLongLatPointArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesAddLineAttribute__mcsResult class.

Encapsulates all output values for RouteAttributesAddLineAttribute function

Properties:

#### AttributeID

Auto-generated difficulty identifier. Essential if GenerateID option was set to true.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesAddPointAttribute__mcsResult class.

Encapsulates all output values for RouteAttributesAddPointAttribute function

Properties:

#### AttributeID

Auto-generated difficulty identifier. Essential if GenerateID option was set to true.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesAddPolygonAttribute__mcsResult class.

Encapsulates all output values for RouteAttributesAddPolygonAttribute function

Properties:

#### AttributeID

Auto-generated difficulty identifier. Essential if GenerateID option was set to true.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesGetAttributesProviderList__mcsResult class.

Encapsulates all output values for RouteAttributesGetAttributesProviderList function

Properties:

#### ProvidersList

A list of providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesGetDataProviderActions__mcsResult class.

Encapsulates all output values for RouteAttributesGetDataProviderActions function

Properties:

#### ActionNames

Action names.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesGetDataProviderParams__mcsResult class.

Encapsulates all output values for RouteAttributesGetDataProviderParams function

Properties:

#### ParamNames

Parameter names.

Type: TWideStringArray

#### ParamValues

Parameter values.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesGetPassedAttributesList__mcsResult class.

Encapsulates all output values for RouteAttributesGetPassedAttributesList function

Properties:

#### VisitedAttributes

List of the difficulties which were taken into account but haven't influenced on the last calculated route.

Type: TSoapTRouteAttributePassedArray

#### BlockedAttributes

List of the difficulties which have influenced on the last calculated route.

Type: TSoapTRouteAttributePassedArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesGetRouteAttribute__mcsResult class.

Encapsulates all output values for RouteAttributesGetRouteAttribute function

Properties:

#### Attribute

Difficulty properties.

Type: TSoapTRouteAttributeParams

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesGetRouteAttributes__mcsResult class.

Encapsulates all output values for RouteAttributesGetRouteAttributes function

Properties:

#### AttributesList

A list of routing difficulties.

Type: TSoapTRouteAttributeParamsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesGetRouteAttributeWithGeometry__mcsResult class.

Encapsulates all output values for RouteAttributesGetRouteAttributeWithGeometry function

Properties:

#### Attribute

Difficulty properties.

Type: TSoapTRouteAttributeParams

#### GeometryKind

Difficulty geometry kind:
- point = 0x00
- road-along placed polyline = 0x01
- polyline = 0x02
- polygon = 0x03
- none = 0x04

Type: Integer

#### Geometry

A list of all difficulty points (number of point is dependent on difficulty geometry kind).

Type: TSoapTLongLatPointArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesGetSubscribedProvidersList__mcsResult class.

Encapsulates all output values for RouteAttributesGetSubscribedProvidersList function

Properties:

#### SubscribedProvidersList

A list of subscribed providers.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesModifyAlongRouteAttribute__mcsResult class.

Encapsulates all output values for RouteAttributesModifyAlongRouteAttribute function

Properties:

#### Representation

All points of generated polyline (if ReturnRepresentation option was set to true).

Type: TSoapTLongLatPointArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteAttributesStoreToBlob__mcsResult class.

Encapsulates all output values for RouteAttributesStoreToBlob function

Properties:

#### BinaryRepresentation

Returned binary representation of routing difficulties.

Type: TByteDynArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerGetDepotEntry__mcsResult class.

Encapsulates all output values for RouteOptimizerGetDepotEntry function

Properties:

#### DepotEntryIndex

Index of the depot waypoint. It is a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerGetEntryDeliveryShipments__mcsResult class.

Encapsulates all output values for RouteOptimizerGetEntryDeliveryShipments function

Properties:

#### DeliveryShipments

Resultant list of delivery shipments defined for a waypoint.

Type: TSoapTShipmentsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerGetEntryPickupShipments__mcsResult class.

Encapsulates all output values for RouteOptimizerGetEntryPickupShipments function

Properties:

#### PickupShipments

Resultant list of pickup shipments defined for a waypoint.

Type: TSoapTShipmentsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerGetEntryShipmentDeliveryPickupTimes__mcsResult class.

Encapsulates all output values for RouteOptimizerGetEntryShipmentDeliveryPickupTimes function

Properties:

#### DeliveryTime

Time of shipment delivery (in minutes).

Type: Integer

#### PickupTime

Time of shipment pickup (in minutes).

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerGetEntryTimeWindows__mcsResult class.

Encapsulates all output values for RouteOptimizerGetEntryTimeWindows function

Properties:

#### TimeWindows

Resultant list of time windows defined for a waypoint.

Type: TSoapTTimeWindowsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerOptimizeRoute__mcsResult class.

Encapsulates all output values for RouteOptimizerOptimizeRoute function

Properties:

#### CyclePoints

Properties of the waypoint entries after optimization process.

Type: TSoapTRouteOptimalizationEntryArray

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### RouteRepresentation

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

Type: TSoapTLongLatPointArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerShipmentTypesGet__mcsResult class.

Encapsulates all output values for RouteOptimizerShipmentTypesGet function

Properties:

#### ShipmentTypes

Resultant list of shipment types.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet__mcsResult class.

Encapsulates all output values for RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet function

Properties:

#### ShipmentTypeToShipmentTypeIncompatibility

Resultant list of incompatibility pairs.

Type: TSoapTShipmentTypeToShipmentTypeIncompatibilityArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerSimpleOptimizeRoute__mcsResult class.

Encapsulates all output values for RouteOptimizerSimpleOptimizeRoute function

Properties:

#### CyclePoints

Properties of the waypoint entries after optimization process.

Type: TSoapTRouteOptimalizationEntryArray

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### RouteRepresentation

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

Type: TSoapTLongLatPointArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerSolveProblem__mcsResult class.

Encapsulates all output values for RouteOptimizerSolveProblem function

Properties:

#### SolutionCost

Total cost of all routes in hundreth parts of the main currency.

Type: Integer

#### Routes

A list of all resultant routes.

Type: TSoapTRouteOptimizerResultRoutesArray

#### ShipmentMoves

A list of shipment events for all routes.

Type: TSoapTRouteOptimizerShipmentMovesArray

#### Entries

A list of all route segments.

Type: TSoapTRouteOptimizerEntryArray

#### ShipmentDeliveries

A list of all resultant delivery shipment actions.

Type: TSoapTRouteOptimizerShipmentActionArray

#### ShipmentPickups

A list of all resultant pickup shipment actions.

Type: TSoapTRouteOptimizerShipmentActionArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet__mcsResult class.

Encapsulates all output values for RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet function

Properties:

#### VehicleCategoryToShipmentTypeIncompatibility

Resultant list of incompatibility pairs.

Type: TSoapTVehicleCategoryToShipmentTypeIncompatibilityArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateAlternativeRoutesAndStore__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateAlternativeRoutesAndStore function

Properties:

#### ResultCount

Number of resultant routes.

Type: Integer

#### TotalRouteLengths

Total length in meters for each calculated route.

Type: TFloatArray

#### TotalRouteTimes

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### TotalRouteCosts

Total cost for each calculated route.

Type: TFloatArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRectArray

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculatePointDistanceFromRoute__mcsResult class.

Encapsulates all output values for RoutePlannerCalculatePointDistanceFromRoute function

Properties:

#### DistanceFromRoute

Resultant list of calculated distances (in meters). If calculated distance is greater then MaxLength, it will equal 0.

Type: TFloatArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculatePointWithinRouteBuffer__mcsResult class.

Encapsulates all output values for RoutePlannerCalculatePointWithinRouteBuffer function

Properties:

#### PointWithinBuffer

Information on point containment within a buffer.

Type: TBooleanArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateRoute__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateRoute function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### RouteRepresentation

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

Type: TSoapTLongLatPointArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateRouteDistanceMatrix__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateRouteDistanceMatrix function

Properties:

#### TotalRouteLengths

Total length in meters for each calculated route.

Type: TSoapTFloatArrayArray

#### TotalRouteTimes

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TSoapTFloatArrayArray

#### TotalRouteCosts

Total cost for each calculated route.

Type: TSoapTFloatArrayArray

#### UnreachableEntry

Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateRouteFromGPSTrack__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateRouteFromGPSTrack function

Properties:

#### RouteRepresentation

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

Type: TSoapTLongLatPointArray

#### BoundingRect

Geographic coordinates of the rectangles bounding route area.

Type: TSoapTLongLatRect

#### TotalRouteLength

Total route length in meters.

Type: Double

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateRoutesWithMultipleDepots__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateRoutesWithMultipleDepots function

Properties:

#### DepotAssigments

A list of start point numbers choosen for calculated routes (beginning with 0).

Type: TDynamicIntegerArray

#### TotalRouteLengths

Total length in meters for each calculated route.

Type: TFloatArray

#### TotalRouteTimes

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### TotalRouteCosts

Total cost for each calculated route.

Type: TFloatArray

#### UnreachableEntry

Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateRoutesWithMultipleDepotsAndStore__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateRoutesWithMultipleDepotsAndStore function

Properties:

#### DepotAssigments

A list of start point numbers choosen for calculated routes (beginning with 0).

Type: TDynamicIntegerArray

#### TotalRouteLengths

Total length in meters for each calculated route.

Type: TFloatArray

#### TotalRouteTimes

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### TotalRouteCosts

Total cost for each calculated route.

Type: TFloatArray

#### UnreachableEntry

Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateRoutesWithSingleDepot__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateRoutesWithSingleDepot function

Properties:

#### TotalRouteLengths

Total length in meters for each calculated route.

Type: TFloatArray

#### TotalRouteTimes

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### TotalRouteCosts

Total cost for each calculated route.

Type: TFloatArray

#### UnreachableEntry

Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateRoutesWithSingleDepotAndStore__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateRoutesWithSingleDepotAndStore function

Properties:

#### TotalRouteLengths

Total length in meters for each calculated route.

Type: TFloatArray

#### TotalRouteTimes

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### TotalRouteCosts

Total cost for each calculated route.

Type: TFloatArray

#### UnreachableEntry

Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerCalculateRouteWithBinaryResult__mcsResult class.

Encapsulates all output values for RoutePlannerCalculateRouteWithBinaryResult function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### BinaryRouteRepresentation

Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.

Type: TByteDynArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerDriverParamsGet__mcsResult class.

Encapsulates all output values for RoutePlannerDriverParamsGet function

Properties:

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntriesAdd__mcsResult class.

Encapsulates all output values for RoutePlannerEntriesAdd function

Properties:

#### RoutePlanEntriesDescription

Automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntriesGet__mcsResult class.

Encapsulates all output values for RoutePlannerEntriesGet function

Properties:

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### RoutePlanVisitTimes

A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### RoutePlanEntriesDescription

Waypoint descriptions.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntriesGetCount__mcsResult class.

Encapsulates all output values for RoutePlannerEntriesGetCount function

Properties:

#### Count

A count of waypoints.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntriesGetWithSnapPoints__mcsResult class.

Encapsulates all output values for RoutePlannerEntriesGetWithSnapPoints function

Properties:

#### RoutePlanEntries

A list of geographic coordinates of waypoints.

Type: TSoapTLongLatPointArray

#### RoutePlanEntriesSnapPoints

A list of geographic coordinates of waypoint's snap points.

Type: TSoapTLongLatPointArray

#### RoutePlanVisitTimes

A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### RoutePlanEntriesDescription

Waypoint descriptions.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntriesSet__mcsResult class.

Encapsulates all output values for RoutePlannerEntriesSet function

Properties:

#### RoutePlanEntriesDescription

Automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntryAdd__mcsResult class.

Encapsulates all output values for RoutePlannerEntryAdd function

Properties:

#### RoutePlanEntryDescription

Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntryGet__mcsResult class.

Encapsulates all output values for RoutePlannerEntryGet function

Properties:

#### RoutePlanEntry

Geographic waypoint coordinates.

Type: TSoapTLongLatPoint

#### RoutePlanVisitTime

Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### RoutePlanEntryDescription

Waypoint description.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntryInsert__mcsResult class.

Encapsulates all output values for RoutePlannerEntryInsert function

Properties:

#### RoutePlanEntryDescription

Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerEntrySet__mcsResult class.

Encapsulates all output values for RoutePlannerEntrySet function

Properties:

#### RoutePlanEntryDescription

Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetAvailableRoadTypes__mcsResult class.

Encapsulates all output values for RoutePlannerGetAvailableRoadTypes function

Properties:

#### RoadTypes

The list of road types.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetParamValue__mcsResult class.

Encapsulates all output values for RoutePlannerGetParamValue function

Properties:

#### ParamValue

Parameter value.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetParamValues__mcsResult class.

Encapsulates all output values for RoutePlannerGetParamValues function

Properties:

#### ParamNames

Parameter names.

Type: TWideStringArray

#### ParamValues

Parameter values.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetRouteItinerary__mcsResult class.

Encapsulates all output values for RoutePlannerGetRouteItinerary function

Properties:

#### RouteItinerary

Resultant route itinerary - a list of all route events.

Type: TSoapTRouteItineraryArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetRouteLogisticTOLLSummary__mcsResult class.

Encapsulates all output values for RoutePlannerGetRouteLogisticTOLLSummary function

Properties:

#### LogisticTOLLRoadResults

Toll costs divided into separated countries.

Type: TSoapTLogisticTOLLResultsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetRouteRepresentation__mcsResult class.

Encapsulates all output values for RoutePlannerGetRouteRepresentation function

Properties:

#### RouteRepresentation

Geographic route representation - a list of all points forming a route.

Type: TSoapTLongLatPointArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetRouteRepresentationWithBinaryResult__mcsResult class.

Encapsulates all output values for RoutePlannerGetRouteRepresentationWithBinaryResult function

Properties:

#### BinaryRouteRepresentation

Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers).

Type: TByteDynArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetRouteSummary__mcsResult class.

Encapsulates all output values for RoutePlannerGetRouteSummary function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerGetRouteViaTollSummary__mcsResult class.

Encapsulates all output values for RoutePlannerGetRouteViaTollSummary function

Properties:

#### ViaTollRoadResults

viaTOLL results divided into separated road types.

Type: TSoapTViaTollRoadResultsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerRoadParamsGet__mcsResult class.

Encapsulates all output values for RoutePlannerRoadParamsGet function

Properties:

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerRoadViaTollParamsGet__mcsResult class.

Encapsulates all output values for RoutePlannerRoadViaTollParamsGet function

Properties:

#### ViaTollRoadParams

viaTOLL parameters.

Type: TSoapTRoadViaTollParamsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerRouteStoreToBlob__mcsResult class.

Encapsulates all output values for RoutePlannerRouteStoreToBlob function

Properties:

#### BinaryRepresentation

Returned binary representation.

Type: TByteDynArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerSimpleCalculateAlternativeRoutesAndStore__mcsResult class.

Encapsulates all output values for RoutePlannerSimpleCalculateAlternativeRoutesAndStore function

Properties:

#### ResultCount

Number of resultant routes.

Type: Integer

#### TotalRouteLengths

Total length in meters for each calculated route.

Type: TFloatArray

#### TotalRouteTimes

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: TFloatArray

#### TotalRouteCosts

Total cost for each calculated route.

Type: TFloatArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRectArray

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerSimpleCalculateRoute__mcsResult class.

Encapsulates all output values for RoutePlannerSimpleCalculateRoute function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### RouteRepresentation

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

Type: TSoapTLongLatPointArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerSimpleCalculateRoute2__mcsResult class.

Encapsulates all output values for RoutePlannerSimpleCalculateRoute2 function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### TotalViaTollLength

Total viaTOLL segments' length in meters.

Type: Double

#### TotalViaTollCost

Total viaTOLL cost.

Type: Double

#### TotalChargeRoadLength

Total length of charged segments (in meters).

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### ViaTollRoadResults

viaTOLL results divided into separated road types.

Type: TSoapTViaTollRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### RouteRepresentation

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

Type: TSoapTLongLatPointArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerSimpleCalculateRoute2WithBinaryResult__mcsResult class.

Encapsulates all output values for RoutePlannerSimpleCalculateRoute2WithBinaryResult function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### TotalViaTollLength

Total viaTOLL segments' length in meters.

Type: Double

#### TotalViaTollCost

Total viaTOLL cost.

Type: Double

#### TotalChargeRoadLength

Total length of charged segments (in meters).

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### ViaTollRoadResults

viaTOLL results divided into separated road types.

Type: TSoapTViaTollRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### BinaryRouteRepresentation

Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.

Type: TByteDynArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerSimpleCalculateRoute3__mcsResult class.

Encapsulates all output values for RoutePlannerSimpleCalculateRoute3 function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### TotalViaTollLength

Total viaTOLL segments' length in meters.

Type: Double

#### TotalViaTollCost

Total viaTOLL cost.

Type: Double

#### TotalChargeRoadLength

Total length of charged segments (in meters).

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### ViaTollRoadResults

viaTOLL results divided into separated road types.

Type: TSoapTViaTollRoadResultsArray

#### LogisticTOLLResults

Toll costs divided into separated countries.

Type: TSoapTLogisticTOLLResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### RouteRepresentation

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

Type: TSoapTLongLatPointArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerSimpleCalculateRoute3WithBinaryResult__mcsResult class.

Encapsulates all output values for RoutePlannerSimpleCalculateRoute3WithBinaryResult function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### TotalViaTollLength

Total viaTOLL segments' length in meters.

Type: Double

#### TotalViaTollCost

Total viaTOLL cost.

Type: Double

#### TotalChargeRoadLength

Total length of charged segments (in meters).

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### ViaTollRoadResults

viaTOLL results divided into separated road types.

Type: TSoapTViaTollRoadResultsArray

#### LogisticTOLLResults

Toll costs divided into separated countries.

Type: TSoapTLogisticTOLLResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### BinaryRouteRepresentation

Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.

Type: TByteDynArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerSimpleCalculateRouteWithBinaryResult__mcsResult class.

Encapsulates all output values for RoutePlannerSimpleCalculateRouteWithBinaryResult function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost without viaTOLL costs.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### BinaryRouteRepresentation

Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.

Type: TByteDynArray

#### RouteItinerary

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

Type: TSoapTRouteItineraryArray

#### RoutePlanEntriesDescription

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

Type: TWideStringArray

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### UnreachableEntry

Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerVehicleParamExGet__mcsResult class.

Encapsulates all output values for RoutePlannerVehicleParamExGet function

Properties:

#### PasamValue

Parameter value.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerVehicleParamsExGet__mcsResult class.

Encapsulates all output values for RoutePlannerVehicleParamsExGet function

Properties:

#### ParamNames

The list of parameter names.

Type: TWideStringArray

#### PasamValues

The list of corresponding parameter values.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerVehicleParamsGet__mcsResult class.

Encapsulates all output values for RoutePlannerVehicleParamsGet function

Properties:

#### VehicleParams

Vehicle parameters.

Type: TSoapTVehicleParams

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRoutePlannerVehicleParamsGet2__mcsResult class.

Encapsulates all output values for RoutePlannerVehicleParamsGet2 function

Properties:

#### VehicleEntry

Vehicle parameters.

Type: TSoapTVehicleEntry

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryCalculatePointDistanceFromRoute__mcsResult class.

Encapsulates all output values for RouteRepositoryCalculatePointDistanceFromRoute function

Properties:

#### DistanceFromRoutes

Resultant matrix of calculated distances (in meters) - for each route and for each point. If calculated distance is greater then MaxLength, it will equal 0.

Type: TSoapTFloatArrayArray

#### RoutesIdents

Resultant list of repository identifiers.

Type: TDynamicIntegerArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryGetRouteItinerary__mcsResult class.

Encapsulates all output values for RouteRepositoryGetRouteItinerary function

Properties:

#### RouteItinerary

Resultant route itinerary - a list of all route events.

Type: TSoapTRouteItineraryArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryGetRouteItineraryByIdent__mcsResult class.

Encapsulates all output values for RouteRepositoryGetRouteItineraryByIdent function

Properties:

#### RouteItinerary

Resultant route itinerary - a list of all route events.

Type: TSoapTRouteItineraryArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryGetRouteRepresentation__mcsResult class.

Encapsulates all output values for RouteRepositoryGetRouteRepresentation function

Properties:

#### RouteRepresentation

Geographic route representation - a list of all points forming a route.

Type: TSoapTLongLatPointArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryGetRouteRepresentationByIdent__mcsResult class.

Encapsulates all output values for RouteRepositoryGetRouteRepresentationByIdent function

Properties:

#### RouteRepresentation

Geographic route representation - a list of all points forming a route.

Type: TSoapTLongLatPointArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryGetRoutes__mcsResult class.

Encapsulates all output values for RouteRepositoryGetRoutes function

Properties:

#### RepositoryRoutes

A list of routes.

Type: TSoapTRepositoryRouteArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryGetRoutesCount__mcsResult class.

Encapsulates all output values for RouteRepositoryGetRoutesCount function

Properties:

#### Count

Repository routes count.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryGetRouteSummary__mcsResult class.

Encapsulates all output values for RouteRepositoryGetRouteSummary function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryGetRouteSummaryByIdent__mcsResult class.

Encapsulates all output values for RouteRepositoryGetRouteSummaryByIdent function

Properties:

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### RoadResults

Route results divided into separated road types.

Type: TSoapTRoadResultsArray

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

#### RouteCalculateType

Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapRouteRepositoryStoreToBlob__mcsResult class.

Encapsulates all output values for RouteRepositoryStoreToBlob function

Properties:

#### BinaryRepresentation

Returned binary representation of route repository.

Type: TByteDynArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchAddCityToSelection__mcsResult class.

Encapsulates all output values for SearchAddCityToSelection function

Properties:

#### BoundingRect

Geographic coordinates of the rectangle bounding the city area.

Type: TSoapTLongLatRect

#### MidPoint

The middle point of the city.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchAddObjectToSelection__mcsResult class.

Encapsulates all output values for SearchAddObjectToSelection function

Properties:

#### BoundingRect

Geographic coordinates of the rectangle bounding the area of the map element.

Type: TSoapTLongLatRect

#### MidPoint

The middle point of the element.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchAddStreetCrossingToSelection__mcsResult class.

Encapsulates all output values for SearchAddStreetCrossingToSelection function

Properties:

#### MidPoint

Geographic coordinates of found crossing point.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchAddStreetWithNumToSelection__mcsResult class.

Encapsulates all output values for SearchAddStreetWithNumToSelection function

Properties:

#### MidPoint

Geographic coordinates of found point.

Type: TSoapTLongLatPoint

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchGetCityList__mcsResult class.

Encapsulates all output values for SearchGetCityList function

Properties:

#### CityNames

The list of found cities.

Type: TWideStringArray

#### CityAdmAbbrev

The list of abbreviations for administrative regions containing found cities. Country and lower level area abreviations are returned for each city as a list of strings.

Type: TSoapTWideStringArrayArray

#### CityAdmNames

The list of administrative regions containing found cities. Country and lower level area names are returned for each city as a list of strings.

Type: TSoapTWideStringArrayArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchGetCityListEx__mcsResult class.

Encapsulates all output values for SearchGetCityListEx function

Properties:

#### CityNames

The list of found cities.

Type: TWideStringArray

#### CityAdmAbbrev

The list of abbreviations for administrative regions containing found cities. Country and lower level area abreviations are returned for each city in form of one string containing the abbreviations separated with character '|'.

Type: TWideStringArray

#### CityAdmNames

The list of administrative regions containing found cities. Country and lower level area names are returned for each city in form of one string containing the names separated with character '|'.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchGetCountryList__mcsResult class.

Encapsulates all output values for SearchGetCountryList function

Properties:

#### CountryNames

The list of countries.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchGetItemKindList__mcsResult class.

Encapsulates all output values for SearchGetItemKindList function

Properties:

#### ItemKindNames

The list of element kinds. Currenty the list contains: squares, estates, quarters, highway exits, airports, roads, rivers, lakes, cemeteries, parks.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchGetItemsList__mcsResult class.

Encapsulates all output values for SearchGetItemsList function

Properties:

#### ItemNames

The list of found map elements.

Type: TWideStringArray

#### ItemTypes

The list of corresponding element kinds being indices in the list returned by SearchGetItemKindList function.

Type: TDynamicIntegerArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchGetParamValue__mcsResult class.

Encapsulates all output values for SearchGetParamValue function

Properties:

#### ParamValue

Parameter value.

Type: WideString

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchGetParamValues__mcsResult class.

Encapsulates all output values for SearchGetParamValues function

Properties:

#### ParamNames

Parameter names.

Type: TWideStringArray

#### ParamValues

Parameter values.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchGetStreetHandle__mcsResult class.

Encapsulates all output values for SearchGetStreetHandle function

Properties:

#### StreetHandle

A handle to the element.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchSelectCities__mcsResult class.

Encapsulates all output values for SearchSelectCities function

Properties:

#### ResultCount

The count of found cities.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchSelectItems__mcsResult class.

Encapsulates all output values for SearchSelectItems function

Properties:

#### ResultCount

The count of found elements.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapSearchSelectItemsEx__mcsResult class.

Encapsulates all output values for SearchSelectItemsEx function

Properties:

#### ResultCount

The count of found elements.

Type: Integer

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapServiceConfigGetServiceParams__mcsResult class.

Encapsulates all output values for ServiceConfigGetServiceParams function

Properties:

#### ParamNames

Parameter names.

Type: TWideStringArray

#### ParamValues

Parameter values.

Type: TWideStringArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapTDegeocodeAtPointDatabaseResult class.

An information concerning a non map object being a result of degeocoding.

Properties:

#### Category

The category of the object found:
- Objects - MapBase objects
- Logistics - logistic objects from MapBase, i.e. traffic difficulties
- Localize - licalization objects
- CalculatedRoute - points of route representation
- RoutePlannerEntries - route waypoints
- TrafficInformation - traffic difficulties stored in the session or subscribed from difficulty providers

Type: WideString

#### Name

Object name or multiline description.

Type: WideString

#### ID

Object identifier.

Type: Integer

#### FoundPoint

Geographic coordinates of the middle point of the object.

Type: TSoapTLongLatPoint

#### FoundLength

Distance (in meters) between found object and the degeocoded point.

Type: Double

### TSoapTDegeocodeAtPointResult class.

An information concerning a map element being a result of degeocoding.

Properties:

#### Category

The category of the element: Forest, Park, Cemetery, River, Lake, Railstation, Building, Square, Estate, Quarter, Highway exit, Airport, Peak, Border crossing and others.

Type: WideString

#### Name

Map element name.

Type: WideString

#### FoundPoint

Geographic coordinates of the middle point of the element.

Type: TSoapTLongLatPoint

#### FoundLength

Distance (in meters) between found map element and the degeocoded point.

Type: Double

### TSoapTDegeocodeCityElementResult class.

An information concerning a city being a result of degeocoding.

Properties:

#### Name

City name.

Type: WideString

#### FoundPoint

Geographic coordinates of the middle point of the city.

Type: TSoapTLongLatPoint

#### FoundLength

Distance (in meters) between found city and the degeocoded point.

Type: Double

### TSoapTDegeocodeExResultEntry class.

An information concerning an element being a result of extended degeocoding.

Properties:

#### PointIndex

An index within the array of degeocoded points which the entry is for, beginning with 0 for the first point.

Type: Integer

#### LayerName

Layer name.

Type: WideString

#### Name

Map element name.

Type: WideString

#### FoundPoint

Geographic coordinates of the middle point of the element.

Type: TSoapTLongLatPoint

#### FoundLength

Distance (in meters) between found map element and the degeocoded point.

Type: Double

### TSoapTDegeocodeResult class.

Geographic information concerning a point on map.

Properties:

#### AreaName0

Country name.

Type: WideString

#### AreaName1

The name of 2nd level administrative area, i.e. a county.

Type: WideString

#### AreaName2

The name of 3rd level administrative area, i.e. a district.

Type: WideString

#### AreaName3

The name of 4th level administrative area.

Type: WideString

#### City

City information.

Type: TSoapTDegeocodeResultEntry

#### Zip

Postal code.

Type: WideString

#### Road

Road information.

Type: TSoapTDegeocodeResultEntry

#### InternationalRoad

International road information.

Type: TSoapTDegeocodeResultEntry

#### Street

Street information.

Type: TSoapTDegeocodeResultEntry

#### Natural

Topographic object information.

Type: TSoapTDegeocodeResultEntry

### TSoapTDegeocodeResultEntry class.

An information concerning a map element being a result of degeocoding.

Properties:

#### Name

Map element name.

Type: WideString

#### FoundPoint

Geographic coordinates of the middle point of the element.

Type: TSoapTLongLatPoint

#### FoundLength

Distance (in meters) between found map element and the degeocoded point.

Type: Double

### TSoapTDegeocodeRoadElementResult class.

An information concerning a road being a result of degeocoding.

Properties:

#### Name

Road name.

Type: WideString

#### IsDirectional

This value is set to true if the road is one-direction road. Otherwise it is set to false.

Type: Boolean

#### IsPassable

This value is set to true if the road is passable. Otherwise it is set to false.

Type: Boolean

#### TypeIndex

The type a the road. The meaning of the value is:
- highway = 0
- speedway = 1
- national road = 2
- regional road = 3
- local road = 4
- main street = 5
- street = 6
- ferry path = 7

Type: Integer

#### FoundPoint

Geographic coordinates of the middle point of the road.

Type: TSoapTLongLatPoint

#### FoundLength

Distance (in meters) between found road and the degeocoded point.

Type: Double

### TSoapTDriverParams class.

Driver parameters.

Properties:

#### JourneyStartTime

Work start time, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

Type: Double

#### DayWorkTime

Day work time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### ContinuousWorkTime

Continuous work time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### BreakTime

Break time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### CostPerKilometer

Cost of 1 kilometer long route sector passed by the driver. It must be nonnegative float value.

Type: Double

#### CostPerHour

Cost of 1 hour route duration passed by the driver. It must be nonnegative float value.

Type: Double

### TSoapTDriveThrough class.

Waypoint properties.

Properties:

#### EntryIndex

Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.

Type: Integer

#### SetAsDriveThrough

Option of setting the waypoint as a drive through waypoint.

Type: Boolean

#### Radius

Waypoint radius in meters (driving tollerance). It must be nonnegative value.

Type: Double

### TSoapTFontParameters class.

A font parameters.

Properties:

#### Name

Font name.

Type: WideString

#### Size

A size of the font.

Type: Integer

#### Color

Font color. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: TColor

#### Style

Font style. It is a bit vector - each bit deals with one font style feature:
- bold = 0x01
- italic = 0x02
- underline = 0x04
- strikeout = 0x08

Type: Integer

#### Charset

Font charset. It is one of following values:
- ANSI charset = 0x00
- default fon charset = 0x01
- eastern european charset = 0xEE
- OEM (operating system depended) charset = 0xFF

Type: Integer

### TSoapTGeocodePointInfo class.

Address information.

Properties:

#### Country

Country name.

Type: WideString

#### County

The name of 2nd level administrative area, i.e. a county.

Type: WideString

#### District

The name of 3rd level administrative area, i.e. a district.

Type: WideString

#### City

City name.

Type: WideString

#### Zip

Postal code.

Type: WideString

#### Street

Street name.

Type: WideString

#### StreetNumber

Number of building on the street.

Type: WideString

### TSoapTGeocodePointInfoEx class.

Extended address information. City, street and administrative abbreviations (terminated with dot) are permitted.

Properties:

#### Country

Country name.

Type: WideString

#### County

The name of 2nd level administrative area, i.e. a county.

Type: WideString

#### District

The name of 3rd level administrative area, i.e. a district.

Type: WideString

#### Commune

The name of 4rd level administrative area, i.e. a commune.

Type: WideString

#### City

City name.

Type: WideString

#### Zip

Postal code.

Type: WideString

#### Street

Street name.

Type: WideString

#### StreetNumber

Number of building on the street.

Type: WideString

### TSoapTGroupSettings class.

Visual settings of an object group.

Properties:

#### GroupName

Name of object group.

Type: WideString

#### IconVisible

Indicates whether the object icons are drawn on maps.

Type: Boolean

#### IconID

Index of icon assigned to the object group. Value 0 means the group has no icon assigned - its icon is dynamically drawn. Otherwise, the index must be one of icon indices returned by GetGroupIcons function.

Type: Integer

#### IconSize

Radius (in pixels) of dynamically drawn object icon. It must be a positive value. The value is essential only when IconIndex equals 0.

Type: Integer

#### IconFillSign

If this option is set to False , dynamically drawn object icon is transparent, otherwise no. The value is essential only when IconIndex equals 0.

Type: Boolean

#### IconColor

The color of the icon. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red). The value is essential only when IconIndex equals 0.

Type: TColor

#### IconBorderSize

Width (in pixels) of the icon border. It must be a nonnegative value. The value is essential only when IconIndex equals 0.

Type: Integer

#### IconBorderColor

The color of the icon border. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red). The value is essential only when IconIndex equals 0.

Type: TColor

#### IconZoomMin

Minimum zoom of object icon visibility being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### IconZoomMax

Maximum zoom of object icon visibility being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### NameVisible

Indicates whether the object names are drawn on maps.

Type: Boolean

#### NameFont

Parameters of object name font.

Type: TSoapTFontParameters

#### NameZoomMin

Minimum zoom of object name visibility being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### NameZoomMax

Maximum zoom of object name visibility being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

### TSoapTGroupShapeSettings class.

Visual shape settings of an object group.

Properties:

#### ShapeVisible

Indicates whether the object shapes are drawn on maps.

Type: Boolean

#### ShapeUnderMap

Indicates whether the object shapes are drawn under maps as a background.

Type: Boolean

#### ShapeFill

Indicates whether to fill the interior the object shapes.

Type: Boolean

#### ShapeColor

The color of shape interiors. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: TColor

#### ShapeBorderSize

Width (in pixels) of the shape border. It must be a nonnegative value.

Type: Integer

#### ShapeBorderColor

The color of shape borders. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: TColor

#### ShapeZoomMin

Minimum zoom of object shape visibility being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

#### ShapeZoomMax

Maximum zoom of object shape visibility being an altitude expressed in meters over sea level. It must be positive value.

Type: Double

### TSoapTIconProperties class.

Icon properties.

Properties:

#### IconID

A unique icon identifier.

Type: Integer

#### IconFormat

Format of the icon. Supported formats can be received using GetAvailableIconFormats function.

Type: WideString

#### IsTransparent

Option of icon transparency.

Type: Boolean

#### TransparentColor

The color of the icon transparency. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

### TSoapTImageRenderParams class.

Parameters used while map image creation.

Properties:

#### RenderWithoutSessionObjects

Option of putting on a map additional session elements, such as search selections, database objects, etc.

Type: Boolean

#### DPI

Resulution of the map image expressed in dots per inch. It must be positive value.

Type: Integer

#### Antialiasing

Option of antialiasing (smoothing) elements of the map image.

Type: Boolean

#### RenderParams

Other parameters (for future use).

Type: WideString

### TSoapTLocalizeObjectPositionData class.

Properties of a localized object position.

Properties:

#### PositionPoint

Geographic coordinates of the position point.

Type: TSoapTLongLatPoint

#### Time

Time (in the GMT time zone) of the position (number of days since 30-12-1899 12:00 AM).

Type: Double

#### Description

The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.

Type: WideString

#### ShowDescription

Information on whether to display the description of the position of the object on the map.

Type: Boolean

#### ShowName

Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).

Type: Boolean

#### IconID

A unique identifier of icon saved in the icons collection in the server session.

Type: Integer

#### ShowIcon

Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).

Type: Boolean

#### IconColor

The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Type: Integer

#### Font

A font of position description displayed on maps.

Type: TSoapTFontParameters

### TSoapTLogisticTOLLResults class.

Summaric cost results of toll roads for the given country.

Properties:

#### CountryName

Name of the country.

Type: WideString

#### EntryType

Toll type, e.g. Charge, Vignette.

Type: WideString

#### PaymentCurrency

Official abbreviation for the original currency.

Type: WideString

#### PaymentOriginalCurrency

Cost in the original currency.

Type: Double

#### PaymentLocalCurrency

Cost in the local currency set in the sever session.

Type: Double

#### VAT

Tax rate (in percents).

Type: Double

### TSoapTLongLatPoint class.

A geographic point based on the WGS84 coordinate system (datum).

Properties:

#### Longitude

Longitude coordinate of the point. It is float value between -180 and 180. Negative values concern western hemisphere (W), positive - eastern (E).

Type: Double

#### Latitude

Latitude coordinate of the point. It is float value between -90 and 90. Negative values concern southern hemisphere (S), positive - northern (N).

Type: Double

### TSoapTLongLatRect class.

A geographic rectangle described with two geographic points.

Properties:

#### TopLeft

Top-left point of the rectangle.

Type: TSoapTLongLatPoint

#### BottomRight

Bottom-right point of the rectangle.

Type: TSoapTLongLatPoint

### TSoapTMapFileEntry class.

Properties of map file loaded by server.

Properties:

#### Filename

Name of the file.

Type: WideString

#### Activated

Map file activity

Type: Boolean

#### FileRegion

Geographic coordinates of rectangle bounding the map file data.

Type: TSoapTLongLatRect

### TSoapTMultiGeocodePointInfoEx class.

Extended address information. City, street and administrative abbreviations (terminated with dot) are permitted.

Properties:

#### SourceIndex

An index within the array of geocoded addresses which the entry is for, beginning with 0 for the first address.

Type: Integer

#### Country

Country name.

Type: WideString

#### County

The name of 2nd level administrative area, i.e. a county.

Type: WideString

#### District

The name of 3rd level administrative area, i.e. a district.

Type: WideString

#### Commune

The name of 4rd level administrative area, i.e. a commune.

Type: WideString

#### City

City name.

Type: WideString

#### Zip

Postal code.

Type: WideString

#### Street

Street name.

Type: WideString

#### StreetNumber

Number of building on the street.

Type: WideString

#### GeocodeLevel

A list of resultant geocode levels for proposals found. The geocode level is a bit vector - each bit deals with one address item:
- country = 0x01
- 2nd level administrative area (county) = 0x02
- 3rd level administrative area (district) = 0x04
- city = 0x08
- postal code = 0x10
- street = 0x20
- building numeration = 0x40
- 4rd level administrative area (commune) = 0x80
If an address item was taken into account while geocoding process, its bit is set to 1. If an address was not geocoded, the geocode level for it has value 0 (all bits set to 0).

Type: Byte

#### Position

A list of resultant geographic coordinates.

Type: TSoapTLongLatPoint

#### BoundingRect

Geographic coordinates of the rectangles bounding objects found.

Type: TSoapTLongLatRect

### TSoapTObjectPosition class.

Geographic data of an object.

Properties:

#### LongLat

Geographic coordinates of an object.

Type: TSoapTLongLatPoint

#### Status

Status of object geographic position obtained while geocoding process (geocode level). The geocode level is a bit vector - each bit deals with one address item:
- country = 0x01
- 2nd level administrative area (county) = 0x02
- 3rd level administrative area (district) = 0x04
- city = 0x08
- postal code = 0x10
- street = 0x20
- building numeration = 0x40
- manually geocoded = 0x80
If an address item was taken into account while geocoding process, its bit is set to 1. If an address was not geocoded, the geocode level for it has value 0 (all bits set to 0).

Type: TGeocodeStatus

### TSoapTPoint class.

Properties:

#### X

Type: Integer

#### Y

Type: Integer

### TSoapTRect class.

Properties:

#### TopLeft

Type: TSoapTPoint

#### BottomRight

Type: TSoapTPoint

### TSoapTRepositoryRoute class.

Properties of route stored in the route repository.

Properties:

#### Ident

Identifier.

Type: Integer

#### Description

Description.

Type: WideString

#### Color

Route color.

Type: TColor

#### Visible

Indicates whether to display a route on maps or not.

Type: Boolean

#### TotalRouteLength

Total route length in meters.

Type: Double

#### TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### TotalRouteCost

Total route cost.

Type: Double

#### TotalFuelCost

Total fuel cost.

Type: Double

#### TollRoadLength

Total length of toll route sectors.

Type: Double

#### TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

Type: Double

#### BoundingRect

Geographic coordinates of the rectangle bounding the route area.

Type: TSoapTLongLatRect

### TSoapTRoadParams class.

Road parameters.

Properties:

#### RoadType

Road type. Supported types can be received using GetAvailableRoadTypes function.

Type: WideString

#### Use

Option of using roads of the type while route calculating.

Type: Boolean

#### Speed

Maximum speed permitted on roads of the type (in km/h). It must be nonnegative value.

Type: Double

#### Combustion

Fuel combustion on road of the type (in l/100km). It must be nonnegative value.

Type: Double

### TSoapTRoadResults class.

Summaric route results taking into account roads of one given type.

Properties:

#### RoadType

Road type. Supported types can be received using GetAvailableRoadTypes function.

Type: WideString

#### Length

Route length in meters.

Type: Double

#### Time

Route duration, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### FuelCost

Fuel combustion cost.

Type: Double

#### VehicleKilometerCost

Vehicle kilometer cost.

Type: Double

#### VehicleHourCost

Vehicle time cost.

Type: Double

#### DriverKilometerCost

Driver kilometer cost.

Type: Double

#### DriverHourCost

Driver time cost.

Type: Double

### TSoapTRoadViaTollParams class.

viaTOLL parameters.

Properties:

#### RoadType

Road type. Supported types can be received using GetAvailableRoadTypes function.

Type: WideString

#### ViaTollCost

Cost per km.

Type: Double

### TSoapTRouteAttributeParams class.

Properties of routing difficulty.

Properties:

#### AttributeID

Difficulty unique identifier.

Type: Integer

#### VehicleFilter

A list of vehicle types the difficulty concerns. The vehicle filter is a bit vector - each bit deals with one vehicle type:
- Passenger car = 0x01
- Transport truck = 0x02
- Motorcycle = 0x04
- Pedestrian = 0x08
- Bicycle = 0x10
- Delivery truck = 0x20
- Residental vehicle = 0x40
- Taxi = 0x80
- Public bus = 0x100
- Straight truck = 0x200
- Non-standard vehicle = 0x400

Type: Integer

#### AttributeName

Difficulty name.

Type: WideString

#### AttributeDescription

Difficulty description.

Type: WideString

#### Closed

Option of blocking routing through the difficulty.

Type: Boolean

#### TwoDirectionalTraffic

Option of enabling two directional traffic through the difficulty.

Type: Boolean

#### MaxSpeed

Maximum speed allowed while routing through the difficulty (in km/h).

Type: Integer

#### MaxWeight

Maximum vehicle weight allowed while routing through the difficulty (in tons).

Type: Double

#### MaxWidth

Maximum vehicle widht allowed while routing through the difficulty (in meters).

Type: Double

#### MaxHeight

Maximum vehicle height allowed while routing through the difficulty (in meters).

Type: Double

#### AdditonalCost

Cost of passing through the difficulty.

Type: Double

#### AdditionalTime

Time of passing through the difficulty, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### BeginTime

Time (in the GMT time zone) of the difficulty binding start (number of days since 30-12-1899 12:00 AM).

Type: Double

#### EndTime

Time (in the GMT time zone) of the difficulty binding stop (number of days since 30-12-1899 12:00 AM).

Type: Double

#### BeginDayTime

Time within a day of difficulty binding start, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

Type: Double

#### EndDayTime

Time within a day of difficulty binding stop, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

Type: Double

### TSoapTRouteAttributePassedElem class.

Properties of the routing difficulty collected while route calculation analyzing.

Properties:

#### SubscriberName

Name of the difficulty provider.

Type: WideString

#### AttributeID

Difficulty unique identifier.

Type: Integer

#### MiddlePosition

Geographical coordinates of the difficulty.

Type: TSoapTLongLatPoint

#### BlockReasonBits

A list of route blocking reasons - a bit vector, each bit deals with one reason:
- impassable way = 0x01
- weight overflow = 0x02
- width overflow = 0x04
- height overflow = 0x08
- length overflow = 0x10
- weight per axle overflow = 0x20
- load type blocked = 0x40

Type: Integer

### TSoapTRouteItinerary class.

Route itinerary entry parameters.

Properties:

#### ItineraryType

Event type:
- Other action = 0x00
- Depart from a waypoint = 0x1
- Arrive at a waypoint = 0x02
- Turn left = 0x03
- Turn right = 0x04
- Bear left = 0x05
- Bear right = 0x6
- Merge onto a highway or motorway, or limited-access road = 0x07
- Continue traveling in the same direction as in the previous instruction = 0x08
- Turn back to travel in the opposite direction as the previous direction = 0x09
- Take a roundabout = 0x0A
- A warning indicating that delays can be expected because of construction = 0x0B
- A warning indicating that stops or road closures can be expected because of road construction = 0x0C
- A warning indicating that the name of the road changes = 0x0D
- Turn or bear left, and then immediately turn or bear left = 0x0E
- Turn or bear left, and then immediately turn or bear right = 0x0F
- Turn or bear right, and then immediately turn or bear left = 0x10
- Turn or bear right, and then immediately turn or bear right = 0x11
- Take a ramp = 0x12
- Take a ramp to the left = 0x13
- Take a ramp to the right = 0x14
- Continue straight when faced with multiple options = 0x15
- Stay to the left when faced with multiple options = 0x16
- Stay to the right when faced with multiple options = 0x17
- Border crossing = 0x18
- Beginning of journey day = 0x19
- End of journey day = 0x1A
- Toll-road gate = 0x1B
- Beginning of toll-road = 0x1C
- End of toll-road = 0x1D
- Beginning of driver rest time = 0x1E
- End of driver rest time = 0x1F
- Beginning of ferry travel = 0x20
- End of ferry travel = 0x21
- Refuel needed = 0x22
- Beginning of charged road = 0x23
- End of charged road = 0x24
- Beginning of viaTOLL road = 0x25
- End of viaTOLL road = 0x26

Type: Integer

#### ItineraryName0

Main description of event. In case of events concerning road name changes (0x03, 0x04, 0x05, 0x06, 0x07, 0x0A, 0x0D, 0x0E, 0x0F, 0x10, 0x11) it contains current road name. For waypoint events (0x01, 0x02) it is waypoint number (the first waypoint has number 1, second has number 2 and so on) and for day change events (0x19, 0x1A) - number of journey day.

Type: WideString

#### ItineraryName1

Additional description of event. In case of events concerning road name changes (0x03, 0x04, 0x05, 0x06, 0x07, 0x0A, 0x0D, 0x0E, 0x0F, 0x10, 0x11) it contains next (target) road name. For waypoint events (0x01, 0x02) it is waypoint description.

Type: WideString

#### EntryPosition

Entry position geographic coordinates.

Type: TSoapTLongLatPoint

#### EntryDistance

Current route distance from a route start point.

Type: Double

#### EntryTime

Current route time, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

Type: Double

#### EntryCost

Current route cost.

Type: Double

### TSoapTRouteOptimalizationEntry class.

Properties of the waypoint entry for route optimization purposes.

Properties:

#### SourceEntryIndex

Original waypoint index before optimization process. The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### DestinationEntryIndex

Result waypoint index after optimization process. The first waypoint has index 0, second has index 1 and so on.

Type: Integer

#### DroppedEntry

For future use.

Type: Boolean

#### DayAssigment

For future use.

Type: Integer

#### DriverAssigment

For future use.

Type: Integer

### TSoapTRouteOptimizerEntry class.

Properties of the optimized route segment.

Properties:

#### ResultRouteInfoIndex

Index of the route within the list of optimized routes, beginning with 0 for the first route.

Type: Integer

#### FromEntryIndex

Start waypoint index for the segment.

Type: Integer

#### ToEntryIndex

Stop waypoint index for the segment.

Type: Integer

#### Duration

Time duration of the segment (in minutes).

Type: Integer

#### Arrival

Arrival time shift for the stop waypoint of the segment (in minutes).

Type: Integer

#### Wait

Time to wait after arrival to the stop waypoint of the segment (in minutes).

Type: Integer

#### ShortBreak

Break time occured within the segment, which is necessary after contigous driving without a break (in minutes).

Type: Integer

### TSoapTRouteOptimizerEntry2 class.

Properties of the optimized route segment.

Properties:

#### ResultRouteInfoIndex

Index of the route within the list of optimized routes, beginning with 0 for the first route.

Type: Integer

#### EntryIndex

Type: Integer

#### Duration

Time duration of the segment (in minutes).

Type: Integer

#### Arrival

Arrival time shift for the stop waypoint of the segment (in minutes).

Type: Integer

#### Wait

Time to wait after arrival to the stop waypoint of the segment (in minutes).

Type: Integer

#### ShortBreak

Break time occured within the segment, which is necessary after contigous driving without a break (in minutes).

Type: Integer

### TSoapTRouteOptimizerEntryAction2 class.

Properties of a single shipment action.

Properties:

#### EntryIndex

Type: Integer

#### TimingBegin

Time shift of the beginning of the action (in minutes).

Type: Integer

#### TimingEnd

Time shift of the end of the action (in minutes).

Type: Integer

#### ShipmentId

Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by EntryIndex.

Type: WideString

#### Pickup

Type: Boolean

### TSoapTRouteOptimizerResultRoutesEntry class.

Properties of the optimized route.

Properties:

#### TimingBegin

Time shift of route beginning (in minutes).

Type: Integer

#### TimingEnd

Time shift of route end (in minutes).

Type: Integer

#### Cost

Total route cost in hundreth parts of the main currency.

Type: Integer

#### VehicleCategory

Category of vehicle for the route.

Type: WideString

### TSoapTRouteOptimizerShipmentAction class.

Properties of a single shipment action.

Properties:

#### EntryIndex

Index of the optimizer entry (route segment) to perform the action, being an index of one of the item in resultant array of type TRouteOptimizerEntryArray, beginning with 0 for the first entry.

Type: Integer

#### IsFromEntry

Indicates whether the action concerns start waypoint of the route segment (FromEntryIndex, when value is true) or stop waypoint (ToEntryIndex, when value is false).

Type: Boolean

#### TimingBegin

Time shift of the beginning of the action (in minutes).

Type: Integer

#### TimingEnd

Time shift of the end of the action (in minutes).

Type: Integer

#### ShipmentId

Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by EntryIndex.

Type: WideString

### TSoapTRouteOptimizerShipmentMove class.

Properties of the optimizer shipment event.

Properties:

#### ResultRouteInfoIndex

Index of the route within the list of optimized routes, beginning with 0 for the first route.

Type: Integer

#### ShipmentId

Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by PickupEntryIndex or DeliverEntryIndex.

Type: WideString

#### PickupEntryIndex

Waypoint index of pickup shipment, beginning with 0 for the first waypoint.

Type: Integer

#### DeliveryEntryIndex

Waypoint index of delivery shipment, beginning with 0 for the first waypoint.

Type: Integer

#### LoadCapacitySize

Size of the shipment (in dm3).

Type: Integer

#### LoadCapacityWeight

Weight of the shipment (in kilograms).

Type: Integer

### TSoapTSessionEnumEntry class.

Properties of a server session.

Properties:

#### SessionID

Session identifier.

Type: WideString

#### SessionIP

IP address of client application, which is owner of the session.

Type: WideString

#### SessionCreateTime

Time of session creation. Time (in the GMT time zone) is number of days since 30-12-1899 12:00 AM.

Type: Double

#### SessionAccessTime

Time of last session query. Time (in the GMT time zone) is number of days since 30-12-1899 12:00 AM.

Type: Double

#### SessionAccessTimes

Number of queries requested by session.

Type: Integer

#### SessionUserName

Name of user assigned to session.

Type: WideString

#### SessionComment

Session comment.

Type: WideString

### TSoapTShipment class.

Properties of the shipment definition.

Properties:

#### ShipmentID

Shipment identifier.

Type: WideString

#### ShipmentType

Shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.

Type: WideString

#### ShipmentSize

Shipment size in m3.

Type: Double

#### ShipmentWeight

Shipment weight (in tons).

Type: Double

#### ShipmentLoadTime

Time of shipment loading (in minutes).

Type: Integer

#### ShipmentUnloadTime

Time of shipment unloading (in minutes).

Type: Integer

### TSoapTShipmentTypeToShipmentTypeIncompatibility class.

A pair of shipment types.

Properties:

#### ShipmentType1

First shipment type.

Type: WideString

#### ShipmentType2

Second shipment type.

Type: WideString

### TSoapTTiledMapParams class.

Parameters used while tiled map image creation.

Properties:

#### Antialiasing

Option of antialiasing (smoothing) elements of the map image.

Type: Boolean

### TSoapTTimeWindow class.

Properties of the time window definiton.

Properties:

#### TimeFrom

Beginning time of the time window, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

Type: Double

#### TimeTo

Ending time of the time window, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

Type: Double

### TSoapTVehicleCategoryToShipmentTypeIncompatibility class.

A pair of vehilce category and shipment type.

Properties:

#### VehicleCategory

Vehicle category.

Type: WideString

#### ShipmentType

Shipment type.

Type: WideString

### TSoapTVehicleEntry class.

Vehicle parameters - TVehicleParams extended with name, external type, count of vehicles and weight per axle.

Properties:

#### VehicleCategory

Vehicle category.

Type: WideString

#### VehicleName

Vehicle name. For future use.

Type: WideString

#### VehicleType

Vehicle type:
- Passenger car = 0x00
- Transport truck = 0x01
- Motorcycle = 0x02
- Pedestrian = 0x03
- Bicycle = 0x04
- Delivery truck = 0x05
- Residental vehicle = 0x06
- Taxi = 0x07
- Public bus = 0x08
- Straight truck = 0x09
- Non-standard vehicle = 0x0A

Type: Integer

#### IgnoreFuel

Option of taking fuel combustion into account while route calculating.

Type: Boolean

#### FixedCost

Fixed route cost. It must be nonnegative float value.

Type: Double

#### CostPerKilometer

Cost of 1 kilometer long route sector passed by the vehicle. It must be nonnegative float value.

Type: Double

#### CostPerHour

Cost of 1 hour route duration passed by the vehicle. It must be nonnegative float value.

Type: Double

#### TollRoadPerKilometer

Cost of 1 kilometer long toll-road.

Type: Double

#### TankCapacity

Vehicle tank capacity in litres. It must be nonnegative float value.

Type: Double

#### FuelCost

Cost of one fuel unit. It must be nonnegative float value.

Type: Double

#### RefuelTime

Refuel time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### VehicleWeight

Vehicle weight in tons. Ignored if 0.

Type: Double

#### VehicleWeightPerAxle

Weight per axle in tons. Ignored if 0.

Type: Double

#### VehicleLength

Vehicle length in meters. Ignored if 0.

Type: Double

#### VehicleHeight

Vehicle height in meters. Ignored if 0.

Type: Double

#### VehicleWidth

Vehicle width in meters. Ignored if 0.

Type: Double

#### VehicleCapacity

Vehicle capacity in m3. It must be nonnegative float value.

Type: Double

#### VehicleLoadCapacity

Vehicle load capacity in tons. It must be nonnegative float value.

Type: Double

#### VehicleMaxCount

Maximal number of vehicles of this kind available.

Type: Integer

#### VehicleLoadType

Vehicle load type. It is a bit vector - each bit deals with one type:
- General hazardous materials = 0x01
- Explosive materials = 0x02
- Goods harmful to water = 0x04

Type: Integer

#### ShippingTime

Ferry shipping time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### BorderPassTime

Border pass time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### VehicleLoadTime

Time of vehicle loading (in minutes).

Type: Integer

#### VehicleUnloadTime

Time of vehicle unloading (in minutes).

Type: Integer

#### VehicleAvailableFrom

Beginning time of the vehicle availability, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

Type: Double

#### VehicleAvailableTo

Ending time of the vehicle availability, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

Type: Double

#### VehicleMaxRouteDuration

Maximal duration of a single route (in minutes).

Type: Integer

#### VehicleMaxCumulDrivingBeforeShortBreak

Maximal duration of a contigous driving without a break (in minutes).

Type: Integer

#### VehicleMaxWaitingTime

Maximal time of waiting at a single route point (in minutes).

Type: Integer

#### VehicleCanDoManyLoads

Option of multiple loadability. For future use.

Type: Boolean

#### VehicleStartingLocationIndex

Index of the starting waypoint for the vehicle. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function. For future use.

Type: Integer

#### VehicleFinishingLocationIndex

Index of the finishing waypoint for the vehicle. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function. For future use.

Type: Integer

### TSoapTVehicleParams class.

Vehicle parameters.

Properties:

#### VehicleType

Vehicle type:
- Passenger car = 0x00
- Transport truck = 0x01
- Motorcycle = 0x02
- Pedestrian = 0x03
- Bicycle = 0x04
- Delivery truck = 0x05
- Residental vehicle = 0x06
- Taxi = 0x07
- Public bus = 0x08
- Straight truck = 0x09
- Non-standard vehicle = 0x0A

Type: Integer

#### IgnoreFuel

Option of taking fuel combustion into account while route calculating.

Type: Boolean

#### FixedCost

Fixed route cost. It must be nonnegative float value.

Type: Double

#### CostPerKilometer

Cost of 1 kilometer long route sector passed by the vehicle. It must be nonnegative float value.

Type: Double

#### CostPerHour

Cost of 1 hour route duration passed by the vehicle. It must be nonnegative float value.

Type: Double

#### TollRoadPerKilometer

Cost of 1 kilometer long toll-road.

Type: Double

#### TankCapacity

Vehicle tank capacity in litres. It must be nonnegative float value.

Type: Double

#### FuelCost

Cost of one fuel unit. It must be nonnegative float value.

Type: Double

#### RefuelTime

Refuel time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### VehicleWeight

Vehicle weight in tons. Ignored if 0.

Type: Double

#### VehicleLength

Vehicle length in meters. Ignored if 0.

Type: Double

#### VehicleHeight

Vehicle height in meters. Ignored if 0.

Type: Double

#### VehicleWidth

Vehicle width in meters. Ignored if 0.

Type: Double

#### VehicleCapacity

Vehicle capacity in m3. It must be nonnegative float value.

Type: Double

#### VehicleLoadCapacity

Vehicle load capacity in tons. It must be nonnegative float value.

Type: Double

#### ShippingTime

Ferry shipping time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

#### BorderPassTime

Border pass time, when value 1 means 1 day, 0.5 means 12 hours and so on.

Type: Double

### TSoapTViaTollRoadResults class.

Summaric viaTOLL results taking into account roads of one given type.

Properties:

#### RoadType

Road type. Supported types can be received using GetAvailableRoadTypes function.

Type: WideString

#### ViaTollLength

Route length in meters.

Type: Double

#### ViaTollCost

viaTOLL cost.

Type: Double

### TSoapTViewConfigEntry class.

Properties of view config file loaded by server.

Properties:

#### ConfigName

View config name.

Type: WideString

#### Filename

Name of the file.

Type: WideString

### TSoapVehicleRepositoryDriverParamsGet__mcsResult class.

Encapsulates all output values for VehicleRepositoryDriverParamsGet function

Properties:

#### DriverParams

Driver parameters.

Type: TSoapTDriverParams

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapVehicleRepositoryRoadParamsGet__mcsResult class.

Encapsulates all output values for VehicleRepositoryRoadParamsGet function

Properties:

#### RoadParams

Road parameters.

Type: TSoapTRoadParamsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapVehicleRepositoryVehicleGet__mcsResult class.

Encapsulates all output values for VehicleRepositoryVehicleGet function

Properties:

#### Vehicle

Parameters of the vehicle.

Type: TSoapTVehicleEntry

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapVehicleRepositoryVehiclesGet__mcsResult class.

Encapsulates all output values for VehicleRepositoryVehiclesGet function

Properties:

#### Vehicles

Resultant list of vehicles.

Type: TSoapTVehicleEntryArray

#### SoapResult

Contains value from error code table.

Type: Integer

### TSoapVehicleRepositoryVehicleViaTollGet__mcsResult class.

Encapsulates all output values for VehicleRepositoryVehicleViaTollGet function

Properties:

#### ViaTollParams

Parameters of the vehicle.

Type: TSoapTRoadViaTollParamsArray

#### SoapResult

Contains value from error code table.

Type: Integer

### OperationSuccessful

Category: Standard errors

Code: 1

Operation successful.

### GeneralError

Category: Standard errors

Code: -1

General error.

### FunctionUnimplemented

Category: Standard errors

Code: -2

Requested function is unimplemented. Required module supporting the function is not delivered.

### SessionNotFound

Category: Standard errors

Code: -3

Given session was not created or has expired. New session may be created using CreateSessionID function.

### NonauthorizedAccess

Category: Standard errors

Code: -4

Server authorization failed. Probably wrong user name or password.

### NotEnoughPermission

Category: Standard errors

Code: -5

An user accessing the server has not enough permission to perform the operation.

### SessionLimitExceeded

Category: Standard errors

Code: -10

A count of available sessions has been exceeded.

### UserSessionLimitExceeded

Category: Standard errors

Code: -11

A count of sessions available for current user has been exceeded.

### WrongAuthentication

Category: Standard errors

Code: -13

An authentication error has occured.

### ReferentialIntegrityError

Category: Data errors

Code: -6

Referential integrity of processed data was violated.

### UniqueIndexViolation

Category: Data errors

Code: -7

Value uniqueness was violated.

### DataNotFound

Category: Data errors

Code: -8

Requested data was not found.

### UpdateRequired

Category: Data errors

Code: -9

A structure of processed database was changed by other session.

### DatabaseBlocked

Category: Data errors

Code: -12

Any modifications in processed database have been blocked by the administrator.

### GeneralSearchError

Category: Search errors

Code: -100

General error occured while searching or geocoding.

### InvalidCountryIndex

Category: Search errors

Code: -101

Given country index is invalid or out of range. It must be a value between 0 and count-1, when count is length of country list obtained using SearchGetCountryList function.

### InvalidCityIndex

Category: Search errors

Code: -102

Given city index is invalid or out of range. It must be a value between 0 and count-1, when count is returned by SearchSelectCities function.

### InvalidCityCount

Category: Search errors

Code: -103

Requested number of cities is invalid or out of range. A value shouldn't be greater then a count returned by SearchSelectCities function.

### InvalidItemKindIndex

Category: Search errors

Code: -104

Given item kind index is invalid or out of range. It must be a value between 0 and count-1, when count is length of list obtained using SearchGetItemKindList function.

### InvalidItemCount

Category: Search errors

Code: -105

Requested number of searched items is invalid or out of range. A value shouldn't be greater then a count returned by SearchSelectItems or SearchSelectItemsEx function.

### InvalidItemIndex

Category: Search errors

Code: -106

Given item index is invalid or out of range. It must be a value between 0 and count-1, when count is returned by SearchSelectItems or SearchSelectItemsEx function.

### StreetRequired

Category: Search errors

Code: -107

Kind of given item must be "roads". A kind for the item is returned by SearchGetItemsList function.

### SearchContextNotInitialized

Category: Search errors

Code: -108

Before any search operations the search context must be initialized using SearchInitialize function.

### InvalidItemHandle

Category: Search errors

Code: -109

Given item handle is invalid. A valid handle may be returned by SearchGetStreetHandle function only.

### NumerationNotFound

Category: Search errors

Code: -110

Given building number was not found on a street.

### CrossingNotFound

Category: Search errors

Code: -111

Crossing for given streets was not found.

### GeneralLocalizeError

Category: Localize errors

Code: -200

General error occured while performing localize operations.

### InvalidLocalizeDataIndex

Category: Localize errors

Code: -201

Given index is invalid or out of range. It must be a value between 0 and count-1, when count is number of elements in some localize collection.

### InvalidIcon

Category: Localize errors

Code: -202

Given image format is not supported.

### InvalidLocalizeEntityID

Category: Localize errors

Code: -203

A localized object with given identifier was not found.

### InvalidNumericFieldsCount

Category: Localize errors

Code: -204

Length of a list of values differs a count of numeric fields collection. The count may be obtained using LocalizeNumFieldsGetCount function.

### InvalidStringFieldsCount

Category: Localize errors

Code: -205

Length of a list of values differs a count of string fields collection. The count may be obtained using LocalizeStrFieldsGetCount function.

### DuplicatedLocalizeEntityID

Category: Localize errors

Code: -206

A localized object with given identifier is already added.

### InvalidIconMIMEType

Category: Localize errors

Code: -207

Given icon MIME type is invalid. The list of supported icon formats may be obtained using GetAvailableIconFormats function.

### InvalidItemsCount

Category: Localize errors

Code: -208

Length of a list of values differs a count of corresponding collection.

### InvalidIconData

Category: Localize errors

Code: -209

Given byte stream was not recognized as a valid icon image.

### GeneralMapFileError

Category: Map file errors

Code: -300

General error occured while processing map files.

### MapFileNotFound

Category: Map file errors

Code: -301

Given file was not found.

### MapFileAlreadyOpened

Category: Map file errors

Code: -302

The map file is already opened. The list of currently loaded map files may be obtained using GetAvailableMapFiles function.

### MapFileAlreadyClosed

Category: Map file errors

Code: -303

The map file is already closed. The list of currently loaded map files may be obtained using GetAvailableMapFiles function.

### WrongFileFormat

Category: Map file errors

Code: -304

The map file has incorrect format.

### GeneralRenderingError

Category: Rendering errors

Code: -400

General error occured while rendering map images.

### InvalidHDCHandle

Category: Rendering errors

Code: -401

Given HDC handle is invalid.

### InvalidImageSize

Category: Rendering errors

Code: -402

Requested map image size is too large.

### InvalidImageMIMEType

Category: Rendering errors

Code: -403

Given map image MIME type is invalid. The list of supported image formats may be obtained using GetAvailableImageFormats function.

### WrongImageSize

Category: Rendering errors

Code: -404

Requested map image size is too small.

### GeneralAuthorizationError

Category: Authorization errors

Code: -500

General error occured while authorization process.

### UserAlreadyExists

Category: Authorization errors

Code: -501

An user beeing added already exists.

### UserDoesNotExist

Category: Authorization errors

Code: -502

Unknown user name.

### UserGroupAlreadyExists

Category: Authorization errors

Code: -503

An user group beeing added already exists.

### UserGroupDoesNotExist

Category: Authorization errors

Code: -504

Unknown user group name.

### UserGroupReadOnly

Category: Authorization errors

Code: -505

An user group can not be modified or removed.

### GeneralRoutePlannerError

Category: RoutePlanner errors

Code: -600

General error occured while route calculating.

### WrongParamValue

Category: RoutePlanner errors

Code: -601

Wrong parameter value.

### WrongParamName

Category: RoutePlanner errors

Code: -602

Wrong parameter name.

### InvalidEntryIndex

Category: RoutePlanner errors

Code: -603

Given waypoint index is invalid or out of range. It must be a value between 0 and count-1, when count can be obtained by RoutePlannerEntriesGetCount function.

### NotEnoughRouteEntries

Category: RoutePlanner errors

Code: -604

At least two waypoints required.

### RouteNotFound

Category: RoutePlanner errors

Code: -605

A route could not be calculated in case of unreachable waypoint.

### DuplicatedEntryIndex

Category: RoutePlanner errors

Code: -606

Given waypoint index hes been given at least two times. It must be unique.

### RouteNotCalculated

Category: RoutePlanner errors

Code: -607

A route could not be found in the server session. No route has been calculated yet.

### RouteIdentifierNotFound

Category: RoutePlanner errors

Code: -608

A route identified by given identifier could not be found in the route repository.

### DuplicatedRoutingDifficultyIdentifier

Category: RoutePlanner errors

Code: -630

Given routing difficulty identifier is not unique.

### RoutingDifficultyIdentifierNotFound

Category: RoutePlanner errors

Code: -631

A routing difficulty identified by given identifier could not be found in the session.

### VehicleCategoryAlreadyExists

Category: RouteOptimizer errors

Code: -660

Given vehicle category is not unique.

### DepotEntryNotSet

Category: RouteOptimizer errors

Code: -661

There is not any waypoint set as starting depot. RouteOptimizerSetDepotEntry should be used.

### DuplicatedShipmentIdentifier

Category: RouteOptimizer errors

Code: -662

Given shipment identifier is not unique.