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. TLongLatPoint
    2. TLongLatRect
    3. TFontParameters
    4. TPoint
    5. TRect
    6. TRectsArray
    7. TLongLatRectArray
    8. TWideStringArray
    9. TLongLatPointArray
    10. TLongLatPoint2DArray
    11. TPointsArray
    12. TCaptionPositionArray
    13. TObjectPosition
    14. TObjectPositionArray
    15. TBooleanArray
    16. TByteArray
    17. TIconProperties
    18. TIconPropertiesArray
    19. TGroupSettings
    20. TGroupShapeSettings
    21. TDynamicIntegerArray
    22. TBlobArray
    23. TDegeocodeResultEntry
    24. TDegeocodeResult
    25. TDegeocodeResultArray
    26. TDegeocodeCityElementResult
    27. TDegeocodeCityElementResultArray
    28. TDegeocodeRoadElementResult
    29. TDegeocodeRoadElementResultArray
    30. TDegeocodeExResultEntry
    31. TDegeocodeExResultEntryArray
    32. TDegeocodeAtPointResult
    33. TDegeocodeAtPointResultArray
    34. TDegeocodeAtPointDatabaseResult
    35. TDegeocodeAtPointDatabaseResultArray
    36. TGeocodePointInfo
    37. TGeocodePointInfoArray
    38. TGeocodePointInfoEx
    39. TGeocodePointInfoExArray
    40. TMultiGeocodePointInfoEx
    41. TMultiGeocodePointInfoExArray
    42. TDynamicByteArray
    43. TTiledMapParams
    44. TImageRenderParams
    45. TFloatArray
    46. TMapFileEntry
    47. TMapFileEntryArray
    48. TFloatArrayArray
    49. TWideStringArrayArray
    50. TBooleanArrayArray
    51. TLocalizeObjectPositionData
    52. TLocalizeObjectPositionDataArray
    53. TSessionEnumEntry
    54. TSessionEnumArray
    55. TViewConfigEntry
    56. TViewConfigListArray
    57. TRepositoryRoute
    58. TRepositoryRouteArray
    59. TRouteAttributeParams
    60. TRouteAttributeParamsArray
    61. TRouteAttributePassedElem
    62. TRouteAttributePassedArray
    63. TDriveThrough
    64. TDriveThroughArray
    65. TTimeWindow
    66. TTimeWindowsArray
    67. TShipment
    68. TShipmentsArray
    69. TRouteOptimalizationEntry
    70. TRouteOptimalizationEntryArray
    71. TRouteOptimizerResultRoutesEntry
    72. TRouteOptimizerResultRoutesArray
    73. TRouteOptimizerEntry2
    74. TRouteOptimizerEntry2Array
    75. TRouteOptimizerEntryAction2
    76. TRouteOptimizerEntryAction2Array
    77. TRouteOptimizerShipmentMove
    78. TRouteOptimizerShipmentMovesArray
    79. TRouteOptimizerEntry
    80. TRouteOptimizerEntryArray
    81. TRouteOptimizerShipmentAction
    82. TRouteOptimizerShipmentActionArray
    83. TRouteItinerary
    84. TRouteItineraryArray
    85. TVehicleParams
    86. TDriverParams
    87. TRoadParams
    88. TRoadParamsArray
    89. TRoadViaTollParams
    90. TRoadViaTollParamsArray
    91. TRoadResults
    92. TRoadResultsArray
    93. TViaTollRoadResults
    94. TViaTollRoadResultsArray
    95. TLogisticTOLLResults
    96. TLogisticTOLLResultsArray
    97. TVehicleEntry
    98. TVehicleEntryArray
    99. TVehicleCategoryToShipmentTypeIncompatibility
    100. TVehicleCategoryToShipmentTypeIncompatibilityArray
    101. TShipmentTypeToShipmentTypeIncompatibility
    102. TShipmentTypeToShipmentTypeIncompatibilityArray
  4. 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).


CreateSessionID

Creates a new server session.

<QUERY>
<MC_QUERY_NAME>CreateSessionID</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>CreateSessionID</MC_ANSWER_NAME>
<SessionID>TSessionID</SessionID>
<Result>Integer</Result>
</ANSWER>

SessionID

Identifier of created session.

Result

Returns value from error code table.

KeepSession

Enforces keeping the session available.

<QUERY>
<MC_QUERY_NAME>KeepSession</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Identifier of the session to be kept.


<ANSWER>
<MC_ANSWER_NAME>KeepSession</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

DropSession

Removes the session with all its data.

<QUERY>
<MC_QUERY_NAME>DropSession</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>DropSession</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetSessionComment

Gets session comment.

<QUERY>
<MC_QUERY_NAME>GetSessionComment</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>GetSessionComment</MC_ANSWER_NAME>
<Comment>WideString</Comment>
<Result>Integer</Result>
</ANSWER>

Comment

Session comment.

Result

Returns value from error code table.

SetSessionComment

Sets session comment.

<QUERY>
<MC_QUERY_NAME>SetSessionComment</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Comment>WideString</Comment>
</QUERY>

SessionID

Session identifier.

Comment

Session comment.


<ANSWER>
<MC_ANSWER_NAME>SetSessionComment</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetSessionLanguageContext

Gets session language context.

<QUERY>
<MC_QUERY_NAME>GetSessionLanguageContext</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ContextIndex>Integer</ContextIndex>
</QUERY>

SessionID

Session identifier.

ContextIndex

Context level (0-2).


<ANSWER>
<MC_ANSWER_NAME>GetSessionLanguageContext</MC_ANSWER_NAME>
<LanguageName>WideString</LanguageName>
<Result>Integer</Result>
</ANSWER>

LanguageName

Language name.

Result

Returns value from error code table.

SetSessionLanguageContext

Sets session language context.

<QUERY>
<MC_QUERY_NAME>SetSessionLanguageContext</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ContextIndex>Integer</ContextIndex>
<LanguageName>WideString</LanguageName>
</QUERY>

SessionID

Session identifier.

ContextIndex

Context level (0-2).

LanguageName

Language name.


<ANSWER>
<MC_ANSWER_NAME>SetSessionLanguageContext</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetMapModules

Returns a list of delivered server modules.

<QUERY>
<MC_QUERY_NAME>GetMapModules</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetMapModules</MC_ANSWER_NAME>
<Modules>
<ITEM>WideString</ITEM>
</Modules>
<Result>Integer</Result>
</ANSWER>

Modules TWideStringArray

The list of server modules.

Result

Returns value from error code table.

GetServerVersion

Returns versions of the server and data components.

<QUERY>
<MC_QUERY_NAME>GetServerVersion</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetServerVersion</MC_ANSWER_NAME>
<ServerVersion>WideString</ServerVersion>
<DataCompilationDate>
<ITEM>WideString</ITEM>
</DataCompilationDate>
<Result>Integer</Result>
</ANSWER>

ServerVersion

Server version.

DataCompilationDate TWideStringArray

The list of versions of subsequent data components.

Result

Returns value from error code table.

GetMaxSessionsCount

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

<QUERY>
<MC_QUERY_NAME>GetMaxSessionsCount</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetMaxSessionsCount</MC_ANSWER_NAME>
<SessionCount>Integer</SessionCount>
<Result>Integer</Result>
</ANSWER>

SessionCount

Resultant number of sessions.

Result

Returns value from error code table.

GetCurrentSessionCount

Returns the number of currently processed server sessions.

<QUERY>
<MC_QUERY_NAME>GetCurrentSessionCount</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetCurrentSessionCount</MC_ANSWER_NAME>
<SessionCount>Integer</SessionCount>
<Result>Integer</Result>
</ANSWER>

SessionCount

Resultant number of sessions.

Result

Returns value from error code table.

GetSessionLifetimeSeconds

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

<QUERY>
<MC_QUERY_NAME>GetSessionLifetimeSeconds</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetSessionLifetimeSeconds</MC_ANSWER_NAME>
<SessionLifetime>Integer</SessionLifetime>
<Result>Integer</Result>
</ANSWER>

SessionLifetime

Resultant time.

Result

Returns value from error code table.

GetActiveSessions

Return statistic information of all active server sessions.

<QUERY>
<MC_QUERY_NAME>GetActiveSessions</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetActiveSessions</MC_ANSWER_NAME>
<Sessions>
<ITEM>
<SessionID>WideString</SessionID>
<SessionIP>WideString</SessionIP>
<SessionCreateTime>Double</SessionCreateTime>
<SessionAccessTime>Double</SessionAccessTime>
<SessionAccessTimes>Integer</SessionAccessTimes>
<SessionUserName>WideString</SessionUserName>
<SessionComment>WideString</SessionComment>
</ITEM>
</Sessions>
<Result>Integer</Result>
</ANSWER>

Sessions TSessionEnumArray

Resultant statistic information.

Result

Returns value from error code table.

AdminDropSession

Removes given session with all its data. Administrative rights are required.

<QUERY>
<MC_QUERY_NAME>AdminDropSession</MC_QUERY_NAME>
<SessionID>WideString</SessionID>
<SessionIP>WideString</SessionIP>
<SessionUserName>WideString</SessionUserName>
</QUERY>

SessionID

Session identifier.

SessionIP

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

SessionUserName

Name of user assigned to session.


<ANSWER>
<MC_ANSWER_NAME>AdminDropSession</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetProjections

Returns a list of supported map projections.

<QUERY>
<MC_QUERY_NAME>GetProjections</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetProjections</MC_ANSWER_NAME>
<Projections>
<ITEM>WideString</ITEM>
</Projections>
<Result>Integer</Result>
</ANSWER>

Projections TWideStringArray

The list of projections.

Result

Returns value from error code table.

GetAvailableImageFormats

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

<QUERY>
<MC_QUERY_NAME>GetAvailableImageFormats</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetAvailableImageFormats</MC_ANSWER_NAME>
<ImageFormats>
<ITEM>WideString</ITEM>
</ImageFormats>
<Result>Integer</Result>
</ANSWER>

ImageFormats TWideStringArray

The list of formats.

Result

Returns value from error code table.

GetDefaultLayers

Returns a list of all default map layers.

<QUERY>
<MC_QUERY_NAME>GetDefaultLayers</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>GetDefaultLayers</MC_ANSWER_NAME>
<MapLayers>
<ITEM>WideString</ITEM>
</MapLayers>
<Result>Integer</Result>
</ANSWER>

MapLayers TWideStringArray

The list of layers.

Result

Returns value from error code table.

GetAvailableMapFiles

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.

<QUERY>
<MC_QUERY_NAME>GetAvailableMapFiles</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetAvailableMapFiles</MC_ANSWER_NAME>
<MapFiles>
<ITEM>
<Filename>WideString</Filename>
<Activated>Boolean</Activated>
<FileRegion>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</FileRegion>
</ITEM>
</MapFiles>
<Result>Integer</Result>
</ANSWER>

MapFiles TMapFileEntryArray

The list of map files.

Result

Returns value from error code table.

GetLoadedMapsRegion

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

<QUERY>
<MC_QUERY_NAME>GetLoadedMapsRegion</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetLoadedMapsRegion</MC_ANSWER_NAME>
<CurrentMapSize>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</CurrentMapSize>
<Result>Integer</Result>
</ANSWER>

CurrentMapSize TLongLatRect

Resultant region.

Result

Returns value from error code table.

ReloadMapFiles

Realoads all map files placed in subdirectory DATA of server installation directory. All loaded map files are activated by default.

<QUERY>
<MC_QUERY_NAME>ReloadMapFiles</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>ReloadMapFiles</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

ActivateMapFile

Activates map file identified by FileName. The file must be one of loaded map files.

<QUERY>
<MC_QUERY_NAME>ActivateMapFile</MC_QUERY_NAME>
<FileName>WideString</FileName>
</QUERY>

FileName

Name of the map file.


<ANSWER>
<MC_ANSWER_NAME>ActivateMapFile</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

DeactivateMapFile

Deactivates map file identified by FileName. The file must be one of loaded map files.

<QUERY>
<MC_QUERY_NAME>DeactivateMapFile</MC_QUERY_NAME>
<FileName>WideString</FileName>
</QUERY>

FileName

Name of the map file.


<ANSWER>
<MC_ANSWER_NAME>DeactivateMapFile</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetViewConfigList

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.

<QUERY>
<MC_QUERY_NAME>GetViewConfigList</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>GetViewConfigList</MC_ANSWER_NAME>
<ViewConfigList>
<ITEM>
<ConfigName>WideString</ConfigName>
<Filename>WideString</Filename>
</ITEM>
</ViewConfigList>
<Result>Integer</Result>
</ANSWER>

ViewConfigList TViewConfigListArray

A list of view configs.

Result

Returns value from error code table.

GetCurrentViewConfig

Returns current session view config.

<QUERY>
<MC_QUERY_NAME>GetCurrentViewConfig</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>GetCurrentViewConfig</MC_ANSWER_NAME>
<ViewConfigName>WideString</ViewConfigName>
<Result>Integer</Result>
</ANSWER>

ViewConfigName

Current view config name.

Result

Returns value from error code table.

SetCurrentViewConfig

Sets current session view config.

<QUERY>
<MC_QUERY_NAME>SetCurrentViewConfig</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ViewConfigName>WideString</ViewConfigName>
</QUERY>

SessionID

Session identifier.

ViewConfigName

View config name.


<ANSWER>
<MC_ANSWER_NAME>SetCurrentViewConfig</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LoadCurrentViewConfig

Loads current session view config from blob.

<QUERY>
<MC_QUERY_NAME>LoadCurrentViewConfig</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ViewConfigBlob>BLOB</ViewConfigBlob>
</QUERY>

SessionID

Session identifier.

ViewConfigBlob

View config file.


<ANSWER>
<MC_ANSWER_NAME>LoadCurrentViewConfig</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthCreateUser

Adds user account.

<QUERY>
<MC_QUERY_NAME>AuthCreateUser</MC_QUERY_NAME>
<Username>WideString</Username>
<Password>WideString</Password>
<Comment>WideString</Comment>
<AccountEnabled>Boolean</AccountEnabled>
<Groups>
<ITEM>WideString</ITEM>
</Groups>
</QUERY>

Username

Username.

Password

Password.

Comment

Comment.

AccountEnabled

Option of account enabling.

Groups TWideStringArray

A list of user groups the account belongs to.


<ANSWER>
<MC_ANSWER_NAME>AuthCreateUser</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthGetUserParams

Returns user's properties.

<QUERY>
<MC_QUERY_NAME>AuthGetUserParams</MC_QUERY_NAME>
<Username>WideString</Username>
</QUERY>

Username

Username.


<ANSWER>
<MC_ANSWER_NAME>AuthGetUserParams</MC_ANSWER_NAME>
<Comment>WideString</Comment>
<AccountEnabled>Boolean</AccountEnabled>
<Groups>
<ITEM>WideString</ITEM>
</Groups>
<Result>Integer</Result>
</ANSWER>

Comment

Comment.

AccountEnabled

Option of account enabling.

Groups TWideStringArray

A list of user groups the account belongs to.

Result

Returns value from error code table.

AuthGetUserParamEx

Returns a value of user's additional parameter.

<QUERY>
<MC_QUERY_NAME>AuthGetUserParamEx</MC_QUERY_NAME>
<Username>WideString</Username>
<ParamName>WideString</ParamName>
</QUERY>

Username

Username.

ParamName

Parameter name.


<ANSWER>
<MC_ANSWER_NAME>AuthGetUserParamEx</MC_ANSWER_NAME>
<ParamValue>WideString</ParamValue>
<Result>Integer</Result>
</ANSWER>

ParamValue

Parameter value.

Result

Returns value from error code table.

AuthSetUserParamEx

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

<QUERY>
<MC_QUERY_NAME>AuthSetUserParamEx</MC_QUERY_NAME>
<Username>WideString</Username>
<ParamName>WideString</ParamName>
<ParamValue>WideString</ParamValue>
</QUERY>

Username

Username.

ParamName

Parameter name.

ParamValue

Parameter value.


<ANSWER>
<MC_ANSWER_NAME>AuthSetUserParamEx</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthModifyUser

Modifies user's account.

<QUERY>
<MC_QUERY_NAME>AuthModifyUser</MC_QUERY_NAME>
<Username>WideString</Username>
<Comment>WideString</Comment>
<AccountEnabled>Boolean</AccountEnabled>
<Groups>
<ITEM>WideString</ITEM>
</Groups>
</QUERY>

Username

Username.

Comment

Comment.

AccountEnabled

Option of account enabling.

Groups TWideStringArray

A list of user groups the account belongs to.


<ANSWER>
<MC_ANSWER_NAME>AuthModifyUser</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthModifyUserPassword

Modifies user's password.

<QUERY>
<MC_QUERY_NAME>AuthModifyUserPassword</MC_QUERY_NAME>
<Username>WideString</Username>
<Password>WideString</Password>
</QUERY>

Username

Username.

Password

New password.


<ANSWER>
<MC_ANSWER_NAME>AuthModifyUserPassword</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthDeleteUser

Removes user's account.

<QUERY>
<MC_QUERY_NAME>AuthDeleteUser</MC_QUERY_NAME>
<Username>WideString</Username>
</QUERY>

Username

Username.


<ANSWER>
<MC_ANSWER_NAME>AuthDeleteUser</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthGetUsersList

Returns a list of server users.

<QUERY>
<MC_QUERY_NAME>AuthGetUsersList</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>AuthGetUsersList</MC_ANSWER_NAME>
<UsersList>
<ITEM>WideString</ITEM>
</UsersList>
<Result>Integer</Result>
</ANSWER>

UsersList TWideStringArray

A list of user names.

Result

Returns value from error code table.

AuthCreateGroup

Adds user group.

<QUERY>
<MC_QUERY_NAME>AuthCreateGroup</MC_QUERY_NAME>
<GroupName>WideString</GroupName>
<GroupComment>WideString</GroupComment>
</QUERY>

GroupName

User group name.

GroupComment

User group comment.


<ANSWER>
<MC_ANSWER_NAME>AuthCreateGroup</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthGetGroup

Returns user group comment.

<QUERY>
<MC_QUERY_NAME>AuthGetGroup</MC_QUERY_NAME>
<GroupName>WideString</GroupName>
</QUERY>

GroupName

User group name.


<ANSWER>
<MC_ANSWER_NAME>AuthGetGroup</MC_ANSWER_NAME>
<GroupComment>WideString</GroupComment>
<Result>Integer</Result>
</ANSWER>

GroupComment

User group comment.

Result

Returns value from error code table.

AuthModifyGroup

Modifies user group properties.

<QUERY>
<MC_QUERY_NAME>AuthModifyGroup</MC_QUERY_NAME>
<GroupName>WideString</GroupName>
<GroupComment>WideString</GroupComment>
</QUERY>

GroupName

User group name.

GroupComment

User group comment.


<ANSWER>
<MC_ANSWER_NAME>AuthModifyGroup</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthDeleteGroup

Removes user group.

<QUERY>
<MC_QUERY_NAME>AuthDeleteGroup</MC_QUERY_NAME>
<GroupName>WideString</GroupName>
</QUERY>

GroupName

User group name.


<ANSWER>
<MC_ANSWER_NAME>AuthDeleteGroup</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AuthGetGroupsList

Returns a list of user groups.

<QUERY>
<MC_QUERY_NAME>AuthGetGroupsList</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>AuthGetGroupsList</MC_ANSWER_NAME>
<GroupsList>
<ITEM>WideString</ITEM>
</GroupsList>
<Result>Integer</Result>
</ANSWER>

GroupsList TWideStringArray

A list of user group names.

Result

Returns value from error code table.

ServiceConfigGetServiceParams

Returns a service config param list. For future use.

<QUERY>
<MC_QUERY_NAME>ServiceConfigGetServiceParams</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>ServiceConfigGetServiceParams</MC_ANSWER_NAME>
<ParamNames>
<ITEM>WideString</ITEM>
</ParamNames>
<ParamValues>
<ITEM>WideString</ITEM>
</ParamValues>
<Result>Integer</Result>
</ANSWER>

ParamNames TWideStringArray

Parameter names.

ParamValues TWideStringArray

Parameter values.

Result

Returns value from error code table.

ServiceConfigSetServiceParam

Sets a service config param. For future use.

<QUERY>
<MC_QUERY_NAME>ServiceConfigSetServiceParam</MC_QUERY_NAME>
<ParamName>WideString</ParamName>
<ParamValue>WideString</ParamValue>
</QUERY>

ParamName

Parameter name.

ParamValue

Parameter value.


<ANSWER>
<MC_ANSWER_NAME>ServiceConfigSetServiceParam</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RenderMapOnImageByPoint

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.

<QUERY>
<MC_QUERY_NAME>RenderMapOnImageByPoint</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
</QUERY>

SessionID

Session identifier.

MimeType

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

MiddlePoint TLongLatPoint

The middle point of requested map.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of returned image.


<ANSWER>
<MC_ANSWER_NAME>RenderMapOnImageByPoint</MC_ANSWER_NAME>
<BitmapImage>BLOB</BitmapImage>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Result>Integer</Result>
</ANSWER>

BitmapImage

The resultant image transferred as a byte stream.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Result

Returns value from error code table.

RenderMapOnImageByRect

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.

<QUERY>
<MC_QUERY_NAME>RenderMapOnImageByRect</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<LeftUpPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LeftUpPoint>
<RightBottomPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RightBottomPoint>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
</QUERY>

SessionID

Session identifier.

MimeType

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

LeftUpPoint TLongLatPoint

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

RightBottomPoint TLongLatPoint

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of returned image.


<ANSWER>
<MC_ANSWER_NAME>RenderMapOnImageByRect</MC_ANSWER_NAME>
<BitmapImage>BLOB</BitmapImage>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Result>Integer</Result>
</ANSWER>

BitmapImage

The resultant image transferred as a byte stream.

MiddlePoint TLongLatPoint

Geographic coordinates of middle point of the resultant map.

MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Result

Returns value from error code table.

RenderSplitMapOnImageByPoint

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.

<QUERY>
<MC_QUERY_NAME>RenderSplitMapOnImageByPoint</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<TileWidth>Integer</TileWidth>
<TileHeight>Integer</TileHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
</QUERY>

SessionID

Session identifier.

MimeType

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

MiddlePoint TLongLatPoint

The middle point of requested map.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

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.

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.

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of returned images.


<ANSWER>
<MC_ANSWER_NAME>RenderSplitMapOnImageByPoint</MC_ANSWER_NAME>
<BitmapImage>
<ITEM>BLOB</ITEM>
</BitmapImage>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Result>Integer</Result>
</ANSWER>

BitmapImage TBlobArray

List of resultant images transferred as a byte stream.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Result

Returns value from error code table.

RenderSplitMapOnImageByRect

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.

<QUERY>
<MC_QUERY_NAME>RenderSplitMapOnImageByRect</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<LeftUpPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LeftUpPoint>
<RightBottomPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RightBottomPoint>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<TileWidth>Integer</TileWidth>
<TileHeight>Integer</TileHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
</QUERY>

SessionID

Session identifier.

MimeType

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

LeftUpPoint TLongLatPoint

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

RightBottomPoint TLongLatPoint

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

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.

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.

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of returned images.


<ANSWER>
<MC_ANSWER_NAME>RenderSplitMapOnImageByRect</MC_ANSWER_NAME>
<BitmapImage>
<ITEM>BLOB</ITEM>
</BitmapImage>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Result>Integer</Result>
</ANSWER>

BitmapImage TBlobArray

List of resultant images transferred as a byte stream.

MiddlePoint TLongLatPoint

Geographic coordinates of middle point of the resultant map.

MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Result

Returns value from error code table.

RenderMapOnHWNDByPoint

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.

<QUERY>
<MC_QUERY_NAME>RenderMapOnHWNDByPoint</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
<HWND>Integer</HWND>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

The middle point of requested map.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of rendered image.

HWND

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


<ANSWER>
<MC_ANSWER_NAME>RenderMapOnHWNDByPoint</MC_ANSWER_NAME>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Result>Integer</Result>
</ANSWER>

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Result

Returns value from error code table.

RenderMapOnHWNDByRect

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.

<QUERY>
<MC_QUERY_NAME>RenderMapOnHWNDByRect</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<LeftUpPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LeftUpPoint>
<RightBottomPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RightBottomPoint>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
<HWND>Integer</HWND>
</QUERY>

SessionID

Session identifier.

LeftUpPoint TLongLatPoint

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

RightBottomPoint TLongLatPoint

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of rendered image.

HWND

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


<ANSWER>
<MC_ANSWER_NAME>RenderMapOnHWNDByRect</MC_ANSWER_NAME>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Result>Integer</Result>
</ANSWER>

MiddlePoint TLongLatPoint

Geographic coordinates of middle point of the resultant map.

MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Result

Returns value from error code table.

RenderMapOnImageByPointWithCopyright

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.

<QUERY>
<MC_QUERY_NAME>RenderMapOnImageByPointWithCopyright</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
</QUERY>

SessionID

Session identifier.

MimeType

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

MiddlePoint TLongLatPoint

The middle point of requested map.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of returned image.


<ANSWER>
<MC_ANSWER_NAME>RenderMapOnImageByPointWithCopyright</MC_ANSWER_NAME>
<BitmapImage>BLOB</BitmapImage>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Copyrights>
<ITEM>WideString</ITEM>
</Copyrights>
<Result>Integer</Result>
</ANSWER>

BitmapImage

The resultant image transferred as a byte stream.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Copyrights TWideStringArray

Copyrights of used map providers.

Result

Returns value from error code table.

RenderMapOnImageByRectWithCopyright

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.

<QUERY>
<MC_QUERY_NAME>RenderMapOnImageByRectWithCopyright</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<LeftUpPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LeftUpPoint>
<RightBottomPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RightBottomPoint>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
</QUERY>

SessionID

Session identifier.

MimeType

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

LeftUpPoint TLongLatPoint

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

RightBottomPoint TLongLatPoint

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of returned image.


<ANSWER>
<MC_ANSWER_NAME>RenderMapOnImageByRectWithCopyright</MC_ANSWER_NAME>
<BitmapImage>BLOB</BitmapImage>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Copyrights>
<ITEM>WideString</ITEM>
</Copyrights>
<Result>Integer</Result>
</ANSWER>

BitmapImage

The resultant image transferred as a byte stream.

MiddlePoint TLongLatPoint

Geographic coordinates of middle point of the resultant map.

MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Copyrights TWideStringArray

Copyrights of used map providers.

Result

Returns value from error code table.

RenderSplitMapOnImageByPointWithCopyright

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.

<QUERY>
<MC_QUERY_NAME>RenderSplitMapOnImageByPointWithCopyright</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<TileWidth>Integer</TileWidth>
<TileHeight>Integer</TileHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
</QUERY>

SessionID

Session identifier.

MimeType

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

MiddlePoint TLongLatPoint

The middle point of requested map.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

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.

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.

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of returned images.


<ANSWER>
<MC_ANSWER_NAME>RenderSplitMapOnImageByPointWithCopyright</MC_ANSWER_NAME>
<BitmapImage>
<ITEM>BLOB</ITEM>
</BitmapImage>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Copyrights>
<ITEM>WideString</ITEM>
</Copyrights>
<Result>Integer</Result>
</ANSWER>

BitmapImage TBlobArray

List of resultant images transferred as a byte stream.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Copyrights TWideStringArray

Copyrights of used map providers.

Result

Returns value from error code table.

RenderSplitMapOnImageByRectWithCopyright

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.

<QUERY>
<MC_QUERY_NAME>RenderSplitMapOnImageByRectWithCopyright</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<LeftUpPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LeftUpPoint>
<RightBottomPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RightBottomPoint>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<TileWidth>Integer</TileWidth>
<TileHeight>Integer</TileHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
</QUERY>

SessionID

Session identifier.

MimeType

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

LeftUpPoint TLongLatPoint

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

RightBottomPoint TLongLatPoint

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

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.

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.

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of returned images.


<ANSWER>
<MC_ANSWER_NAME>RenderSplitMapOnImageByRectWithCopyright</MC_ANSWER_NAME>
<BitmapImage>
<ITEM>BLOB</ITEM>
</BitmapImage>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Copyrights>
<ITEM>WideString</ITEM>
</Copyrights>
<Result>Integer</Result>
</ANSWER>

BitmapImage TBlobArray

List of resultant images transferred as a byte stream.

MiddlePoint TLongLatPoint

Geographic coordinates of middle point of the resultant map.

MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Copyrights TWideStringArray

Copyrights of used map providers.

Result

Returns value from error code table.

RenderMapOnHWNDByPointWithCopyright

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.

<QUERY>
<MC_QUERY_NAME>RenderMapOnHWNDByPointWithCopyright</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
<HWND>Integer</HWND>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

The middle point of requested map.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of rendered image.

HWND

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


<ANSWER>
<MC_ANSWER_NAME>RenderMapOnHWNDByPointWithCopyright</MC_ANSWER_NAME>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Copyrights>
<ITEM>WideString</ITEM>
</Copyrights>
<Result>Integer</Result>
</ANSWER>

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Copyrights TWideStringArray

Copyrights of used map providers.

Result

Returns value from error code table.

RenderMapOnHWNDByRectWithCopyright

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.

<QUERY>
<MC_QUERY_NAME>RenderMapOnHWNDByRectWithCopyright</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<LeftUpPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LeftUpPoint>
<RightBottomPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RightBottomPoint>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
<HWND>Integer</HWND>
</QUERY>

SessionID

Session identifier.

LeftUpPoint TLongLatPoint

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

RightBottomPoint TLongLatPoint

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

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

BitmapHeight

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

VisibleLayers TWideStringArray

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

ImageRenderParams TImageRenderParams

Other parameters of rendered image.

HWND

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


<ANSWER>
<MC_ANSWER_NAME>RenderMapOnHWNDByRectWithCopyright</MC_ANSWER_NAME>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<BitmapRightUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightUpCorner>
<BitmapRightDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapRightDownCorner>
<BitmapLeftUpCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftUpCorner>
<BitmapLeftDownCorner>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BitmapLeftDownCorner>
<Copyrights>
<ITEM>WideString</ITEM>
</Copyrights>
<Result>Integer</Result>
</ANSWER>

MiddlePoint TLongLatPoint

Geographic coordinates of middle point of the resultant map.

MapAltitude

Zoom of the resultant map being an altitude expressed in meters over sea level.

BitmapRightUpCorner TLongLatPoint

Geographic coordinates of right-up point of the resultant map.

BitmapRightDownCorner TLongLatPoint

Geographic coordinates of right-down point of the resultant map.

BitmapLeftUpCorner TLongLatPoint

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

BitmapLeftDownCorner TLongLatPoint

Geographic coordinates of left-down point of the resultant map.

Copyrights TWideStringArray

Copyrights of used map providers.

Result

Returns value from error code table.

ClearMapSelection

Removes all session selections, i.e. selections of found map elements.

<QUERY>
<MC_QUERY_NAME>ClearMapSelection</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>ClearMapSelection</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RenderTiledMap

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.

<QUERY>
<MC_QUERY_NAME>RenderTiledMap</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<PositionX>Integer</PositionX>
<PositionY>Integer</PositionY>
<Zoom>Integer</Zoom>
<RenderParam>
<Antialiasing>Boolean</Antialiasing>
</RenderParam>
<TiledMapLayers>
<ITEM>WideString</ITEM>
</TiledMapLayers>
</QUERY>

SessionID

Session identifier.

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".

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.

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.

Zoom

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

RenderParam TTiledMapParams

Other parameters of returned images.

TiledMapLayers TWideStringArray

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


<ANSWER>
<MC_ANSWER_NAME>RenderTiledMap</MC_ANSWER_NAME>
<BitmapImages>
<ITEM>BLOB</ITEM>
</BitmapImages>
<TilesX>Integer</TilesX>
<TilesY>Integer</TilesY>
<Result>Integer</Result>
</ANSWER>

BitmapImages TBlobArray

List of resultant images transferred as a byte stream.

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.

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.

Result

Returns value from error code table.

RenderTiledMapWithCopyright

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.

<QUERY>
<MC_QUERY_NAME>RenderTiledMapWithCopyright</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<PositionX>Integer</PositionX>
<PositionY>Integer</PositionY>
<Zoom>Integer</Zoom>
<RenderParam>
<Antialiasing>Boolean</Antialiasing>
</RenderParam>
<TiledMapLayers>
<ITEM>WideString</ITEM>
</TiledMapLayers>
</QUERY>

SessionID

Session identifier.

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".

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.

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.

Zoom

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

RenderParam TTiledMapParams

Other parameters of returned images.

TiledMapLayers TWideStringArray

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


<ANSWER>
<MC_ANSWER_NAME>RenderTiledMapWithCopyright</MC_ANSWER_NAME>
<BitmapImages>
<ITEM>BLOB</ITEM>
</BitmapImages>
<TilesX>Integer</TilesX>
<TilesY>Integer</TilesY>
<Copyrights>
<ITEM>WideString</ITEM>
</Copyrights>
<Result>Integer</Result>
</ANSWER>

BitmapImages TBlobArray

List of resultant images transferred as a byte stream.

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.

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.

Copyrights TWideStringArray

Copyrights of used map providers.

Result

Returns value from error code table.

RenderTiledMapEx

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.

<QUERY>
<MC_QUERY_NAME>RenderTiledMapEx</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MimeType>WideString</MimeType>
<PositionX>Integer</PositionX>
<PositionY>Integer</PositionY>
<Zoom>Integer</Zoom>
<RenderParam>
<Antialiasing>Boolean</Antialiasing>
</RenderParam>
<TiledMapLayers>
<ITEM>WideString</ITEM>
</TiledMapLayers>
<VisibleLayers>
<ITEM>WideString</ITEM>
</VisibleLayers>
</QUERY>

SessionID

Session identifier.

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".

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.

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.

Zoom

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

RenderParam TTiledMapParams

Other parameters of returned images.

TiledMapLayers TWideStringArray

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

VisibleLayers TWideStringArray

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


<ANSWER>
<MC_ANSWER_NAME>RenderTiledMapEx</MC_ANSWER_NAME>
<BitmapImagesPresent>
<ITEM>Boolean</ITEM>
</BitmapImagesPresent>
<BitmapImages>
<ITEM>BLOB</ITEM>
</BitmapImages>
<TilesX>Integer</TilesX>
<TilesY>Integer</TilesY>
<Copyrights>
<ITEM>WideString</ITEM>
</Copyrights>
<Result>Integer</Result>
</ANSWER>

BitmapImagesPresent TBooleanArray

List of presence of subseqent images within the resultant images.

BitmapImages TBlobArray

List of resultant images transferred as a byte stream.

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.

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.

Copyrights TWideStringArray

Copyrights of used map providers.

Result

Returns value from error code table.

GetTiledMapLayers

Returns a list of all layers supported by RenderTiledMap function.

<QUERY>
<MC_QUERY_NAME>GetTiledMapLayers</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>GetTiledMapLayers</MC_ANSWER_NAME>
<TiledMapLayers>
<ITEM>WideString</ITEM>
</TiledMapLayers>
<Result>Integer</Result>
</ANSWER>

TiledMapLayers TWideStringArray

The list of layers.

Result

Returns value from error code table.

ConvertMapToScreen

Converts geographic coordinates to screen coordinates (image pixels).

<QUERY>
<MC_QUERY_NAME>ConvertMapToScreen</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
<MapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPoints>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

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

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

Width of the image. It must be positive value.

BitmapHeight

Height of the image. It must be positive value.

ImageRenderParams TImageRenderParams

Other parameters of the image.

MapPoints TLongLatPointArray

A list of geographic points to be converted.


<ANSWER>
<MC_ANSWER_NAME>ConvertMapToScreen</MC_ANSWER_NAME>
<ScreenPoints>
<ITEM>
<X>Integer</X>
<Y>Integer</Y>
</ITEM>
</ScreenPoints>
<Result>Integer</Result>
</ANSWER>

ScreenPoints TPointsArray

The resultant list of screen points. Their coordinates may be negative or higher than given image sizes.

Result

Returns value from error code table.

ConvertScreenToMap

Converts screen coordinates (image pixels) to geographic ones.

<QUERY>
<MC_QUERY_NAME>ConvertScreenToMap</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
<ScreenPoints>
<ITEM>
<X>Integer</X>
<Y>Integer</Y>
</ITEM>
</ScreenPoints>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

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

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

Width of the image. It must be positive value.

BitmapHeight

Height of the image. It must be positive value.

ImageRenderParams TImageRenderParams

Other parameters of the image.

ScreenPoints TPointsArray

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


<ANSWER>
<MC_ANSWER_NAME>ConvertScreenToMap</MC_ANSWER_NAME>
<MapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPoints>
<Result>Integer</Result>
</ANSWER>

MapPoints TLongLatPointArray

The resultant list of geographic points.

Result

Returns value from error code table.

GetMapPointLength

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

<QUERY>
<MC_QUERY_NAME>GetMapPointLength</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPoints>
</QUERY>

SessionID

Session identifier.

MapPoints TLongLatPointArray

The list of geographic points forming the path.


<ANSWER>
<MC_ANSWER_NAME>GetMapPointLength</MC_ANSWER_NAME>
<Distance>Double</Distance>
<Result>Integer</Result>
</ANSWER>

Distance

Resultant distance (in meters).

Result

Returns value from error code table.

GetScreenPointLength

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

<QUERY>
<MC_QUERY_NAME>GetScreenPointLength</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<BitmapWidth>Integer</BitmapWidth>
<BitmapHeight>Integer</BitmapHeight>
<ImageRenderParams>
<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>
</ImageRenderParams>
<ScreenPoints>
<ITEM>
<X>Integer</X>
<Y>Integer</Y>
</ITEM>
</ScreenPoints>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

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

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

BitmapWidth

Width of the image. It must be positive value.

BitmapHeight

Height of the image. It must be positive value.

ImageRenderParams TImageRenderParams

Other parameters of the image.

ScreenPoints TPointsArray

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


<ANSWER>
<MC_ANSWER_NAME>GetScreenPointLength</MC_ANSWER_NAME>
<Distance>Double</Distance>
<Result>Integer</Result>
</ANSWER>

Distance

Resultant distance (in meters).

Result

Returns value from error code table.

InverseCalc

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

<QUERY>
<MC_QUERY_NAME>InverseCalc</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<StartPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</StartPoint>
<StopPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</StopPoint>
</QUERY>

SessionID

Session identifier.

StartPoint TLongLatPoint

Geographic coordinates of the start point.

StopPoint TLongLatPoint

Geographic coordinates of the stop point.


<ANSWER>
<MC_ANSWER_NAME>InverseCalc</MC_ANSWER_NAME>
<Length>Double</Length>
<Azimuth12>Double</Azimuth12>
<Azimuth21>Double</Azimuth21>
<Result>Integer</Result>
</ANSWER>

Length

Resultant distance (in meters).

Azimuth12

Resultant azimuth from the start to the stop point. It is an angle in degrees between 0 and 360 counterclockwise.

Azimuth21

Resultant azimuth from the stop to the start point. It is an angle in degrees between 0 and 360 counterclockwise.

Result

Returns value from error code table.

ForwardCalc

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

<QUERY>
<MC_QUERY_NAME>ForwardCalc</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<StartPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</StartPoint>
<Length>Double</Length>
<Azimuth>Double</Azimuth>
</QUERY>

SessionID

Session identifier.

StartPoint TLongLatPoint

Geographic coordinates of the start point.

Length

Distance from the start point.

Azimuth

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


<ANSWER>
<MC_ANSWER_NAME>ForwardCalc</MC_ANSWER_NAME>
<StopPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</StopPoint>
<Result>Integer</Result>
</ANSWER>

StopPoint TLongLatPoint

Geographic coordinates of the resultant stop point.

Result

Returns value from error code table.

GetDegeocodeLayers

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

<QUERY>
<MC_QUERY_NAME>GetDegeocodeLayers</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>GetDegeocodeLayers</MC_ANSWER_NAME>
<DegeocodeLayers>
<ITEM>WideString</ITEM>
</DegeocodeLayers>
<Result>Integer</Result>
</ANSWER>

DegeocodeLayers TWideStringArray

The list of layers.

Result

Returns value from error code table.

DegeocodeGetParamValue

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)

<QUERY>
<MC_QUERY_NAME>DegeocodeGetParamValue</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ParamName>WideString</ParamName>
</QUERY>

SessionID

Session identifier.

ParamName

Parameter name.


<ANSWER>
<MC_ANSWER_NAME>DegeocodeGetParamValue</MC_ANSWER_NAME>
<ParamValue>WideString</ParamValue>
<Result>Integer</Result>
</ANSWER>

ParamValue

Parameter value.

Result

Returns value from error code table.

DegeocodeSetParamValue

Sets a value for given parameter of degeocoding stored in the session.

<QUERY>
<MC_QUERY_NAME>DegeocodeSetParamValue</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ParamName>WideString</ParamName>
<ParamValue>WideString</ParamValue>
</QUERY>

SessionID

Session identifier.

ParamName

Parameter name.

ParamValue

Parameter value.


<ANSWER>
<MC_ANSWER_NAME>DegeocodeSetParamValue</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

Degeocode

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.

<QUERY>
<MC_QUERY_NAME>Degeocode</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<MapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPoints>
<QueryRadius>Double</QueryRadius>
<DegeocodeLayers>
<ITEM>WideString</ITEM>
</DegeocodeLayers>
<OnlyNamedEntries>Boolean</OnlyNamedEntries>
<UseViewVisibility>Boolean</UseViewVisibility>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

An orientation point.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

MapPoints TLongLatPointArray

The list of points to be degeocoded.

QueryRadius

Search radius in meters. It must be nonnegative value.

DegeocodeLayers TWideStringArray

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

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.

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.


<ANSWER>
<MC_ANSWER_NAME>Degeocode</MC_ANSWER_NAME>
<Results>
<ITEM>
<AreaName0>WideString</AreaName0>
<AreaName1>WideString</AreaName1>
<AreaName2>WideString</AreaName2>
<AreaName3>WideString</AreaName3>
<City>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</City>
<Zip>WideString</Zip>
<Road>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Road>
<InternationalRoad>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</InternationalRoad>
<Street>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Street>
<Natural>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Natural>
</ITEM>
</Results>
<Result>Integer</Result>
</ANSWER>

Results TDegeocodeResultArray

The list of geographic information entries.

Result

Returns value from error code table.

DegeocodeEx

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

<QUERY>
<MC_QUERY_NAME>DegeocodeEx</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<MapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPoints>
<QueryRadius>Double</QueryRadius>
<DegeocodeLayers>
<ITEM>WideString</ITEM>
</DegeocodeLayers>
<OnlyNamedEntries>Boolean</OnlyNamedEntries>
<UseViewVisibility>Boolean</UseViewVisibility>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

An orientation point.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

MapPoints TLongLatPointArray

The list of points to be degeocoded.

QueryRadius

Search radius in meters. It must be nonnegative value.

DegeocodeLayers TWideStringArray

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

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.

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.


<ANSWER>
<MC_ANSWER_NAME>DegeocodeEx</MC_ANSWER_NAME>
<Results>
<ITEM>
<AreaName0>WideString</AreaName0>
<AreaName1>WideString</AreaName1>
<AreaName2>WideString</AreaName2>
<AreaName3>WideString</AreaName3>
<City>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</City>
<Zip>WideString</Zip>
<Road>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Road>
<InternationalRoad>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</InternationalRoad>
<Street>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Street>
<Natural>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Natural>
</ITEM>
</Results>
<OtherElements>
<ITEM>
<PointIndex>Integer</PointIndex>
<LayerName>WideString</LayerName>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</OtherElements>
<Result>Integer</Result>
</ANSWER>

Results TDegeocodeResultArray

The list of geographic information entries.

OtherElements TDegeocodeExResultEntryArray

The list of other elements found.

Result

Returns value from error code table.

DegeocodeExWithAttributes

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.

<QUERY>
<MC_QUERY_NAME>DegeocodeExWithAttributes</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<MapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPoints>
<MapPointAttributes>
<ITEM>WideString</ITEM>
</MapPointAttributes>
<QueryRadius>Double</QueryRadius>
<DegeocodeLayers>
<ITEM>WideString</ITEM>
</DegeocodeLayers>
<OnlyNamedEntries>Boolean</OnlyNamedEntries>
<UseViewVisibility>Boolean</UseViewVisibility>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

An orientation point.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

MapPoints TLongLatPointArray

The list of points to be degeocoded.

MapPointAttributes TWideStringArray

The list of point's additional attributes.

QueryRadius

Search radius in meters. It must be nonnegative value.

DegeocodeLayers TWideStringArray

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

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.

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.


<ANSWER>
<MC_ANSWER_NAME>DegeocodeExWithAttributes</MC_ANSWER_NAME>
<Results>
<ITEM>
<AreaName0>WideString</AreaName0>
<AreaName1>WideString</AreaName1>
<AreaName2>WideString</AreaName2>
<AreaName3>WideString</AreaName3>
<City>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</City>
<Zip>WideString</Zip>
<Road>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Road>
<InternationalRoad>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</InternationalRoad>
<Street>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Street>
<Natural>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Natural>
</ITEM>
</Results>
<OtherElements>
<ITEM>
<PointIndex>Integer</PointIndex>
<LayerName>WideString</LayerName>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</OtherElements>
<Result>Integer</Result>
</ANSWER>

Results TDegeocodeResultArray

The list of geographic information entries.

OtherElements TDegeocodeExResultEntryArray

The list of other elements found.

Result

Returns value from error code table.

DegeocodeAtPoint

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

<QUERY>
<MC_QUERY_NAME>DegeocodeAtPoint</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<MapAltitude>Double</MapAltitude>
<MapRotation>Double</MapRotation>
<MapTilt>Double</MapTilt>
<MapProjection>WideString</MapProjection>
<MapProjectionParams>WideString</MapProjectionParams>
<DegeocodePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</DegeocodePoint>
<QueryRadius>Double</QueryRadius>
<MaxElems>Integer</MaxElems>
<DegeocodeLayers>
<ITEM>WideString</ITEM>
</DegeocodeLayers>
<OnlyNamedEntries>Boolean</OnlyNamedEntries>
<UseViewVisibility>Boolean</UseViewVisibility>
</QUERY>

SessionID

Session identifier.

MiddlePoint TLongLatPoint

An orientation point.

MapAltitude

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

MapRotation

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

MapTilt

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

MapProjection

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

MapProjectionParams

For future use.

DegeocodePoint TLongLatPoint

Geographic coordinates of the degeocoded point.

QueryRadius

Search radius in meters. It must be nonnegative value.

MaxElems

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

DegeocodeLayers TWideStringArray

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

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.

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.


<ANSWER>
<MC_ANSWER_NAME>DegeocodeAtPoint</MC_ANSWER_NAME>
<AreaName0>WideString</AreaName0>
<AreaName1>WideString</AreaName1>
<AreaName2>WideString</AreaName2>
<AreaName3>WideString</AreaName3>
<City>
<ITEM>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</City>
<Zip>WideString</Zip>
<Road>
<ITEM>
<Name>WideString</Name>
<IsDirectional>Boolean</IsDirectional>
<IsPassable>Boolean</IsPassable>
<TypeIndex>Integer</TypeIndex>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</Road>
<InternationalRoad>
<ITEM>
<Name>WideString</Name>
<IsDirectional>Boolean</IsDirectional>
<IsPassable>Boolean</IsPassable>
<TypeIndex>Integer</TypeIndex>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</InternationalRoad>
<Street>
<ITEM>
<Name>WideString</Name>
<IsDirectional>Boolean</IsDirectional>
<IsPassable>Boolean</IsPassable>
<TypeIndex>Integer</TypeIndex>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</Street>
<Natural>
<ITEM>
<Category>WideString</Category>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</Natural>
<OtherMapElements>
<ITEM>
<Category>WideString</Category>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</OtherMapElements>
<DatabaseElements>
<ITEM>
<Category>WideString</Category>
<Name>WideString</Name>
<ID>Integer</ID>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>
</DatabaseElements>
<Result>Integer</Result>
</ANSWER>

AreaName0

Country name.

AreaName1

The name of 2nd level administrative area, i.e. a county.

AreaName2

The name of 3rd level administrative area, i.e. a district.

AreaName3

The name of 4th level administrative area.

City TDegeocodeCityElementResultArray

The list of found cities.

Zip

Postal code.

Road TDegeocodeRoadElementResultArray

The list of roads found.

InternationalRoad TDegeocodeRoadElementResultArray

The list of international roads found.

Street TDegeocodeRoadElementResultArray

The list of streets found.

Natural TDegeocodeAtPointResultArray

The list of topographic objects found.

OtherMapElements TDegeocodeAtPointResultArray

The list of other map elements found.

DatabaseElements TDegeocodeAtPointDatabaseResultArray

The list of external objects found (saved in the session and placed on a map).

Result

Returns value from error code table.

MapBaseConnect

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.

<QUERY>
<MC_QUERY_NAME>MapBaseConnect</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DatabaseType>WideString</DatabaseType>
<ConnectionString>TConnectionString</ConnectionString>
</QUERY>

SessionID

Session identifier.

DatabaseType

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

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.


<ANSWER>
<MC_ANSWER_NAME>MapBaseConnect</MC_ANSWER_NAME>
<AccessLevel>Integer</AccessLevel>
<Result>Integer</Result>
</ANSWER>

AccessLevel

Indicates whether logged user has permissions to change data (0 = administrative privileges, 1 = editing, 2 = read only access).

Result

Returns value from error code table.

MapBaseDisconnect

Disconnects given server session from a database. Some connection of given database type should be active before.

<QUERY>
<MC_QUERY_NAME>MapBaseDisconnect</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DatabaseType>WideString</DatabaseType>
</QUERY>

SessionID

Session identifier.

DatabaseType

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


<ANSWER>
<MC_ANSWER_NAME>MapBaseDisconnect</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

MapBaseLoadFromBlob

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.

<QUERY>
<MC_QUERY_NAME>MapBaseLoadFromBlob</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DatabaseType>WideString</DatabaseType>
<BinaryData>BLOB</BinaryData>
</QUERY>

SessionID

Session identifier.

DatabaseType

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

BinaryData

A database file content.


<ANSWER>
<MC_ANSWER_NAME>MapBaseLoadFromBlob</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

MapBaseStoreToBlob

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

<QUERY>
<MC_QUERY_NAME>MapBaseStoreToBlob</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DatabaseType>WideString</DatabaseType>
</QUERY>

SessionID

Session identifier.

DatabaseType

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


<ANSWER>
<MC_ANSWER_NAME>MapBaseStoreToBlob</MC_ANSWER_NAME>
<BinaryData>BLOB</BinaryData>
<Result>Integer</Result>
</ANSWER>

BinaryData

A database content.

Result

Returns value from error code table.

GetDatabaseList

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

<QUERY>
<MC_QUERY_NAME>GetDatabaseList</MC_QUERY_NAME>
<DatabaseType>WideString</DatabaseType>
</QUERY>

DatabaseType

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


<ANSWER>
<MC_ANSWER_NAME>GetDatabaseList</MC_ANSWER_NAME>
<DatabaseList>
<ITEM>WideString</ITEM>
</DatabaseList>
<Result>Integer</Result>
</ANSWER>

DatabaseList TWideStringArray

A list of available databases.

Result

Returns value from error code table.

GetDatabaseTableList

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

<QUERY>
<MC_QUERY_NAME>GetDatabaseTableList</MC_QUERY_NAME>
<DatabaseType>WideString</DatabaseType>
</QUERY>

DatabaseType

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


<ANSWER>
<MC_ANSWER_NAME>GetDatabaseTableList</MC_ANSWER_NAME>
<DatabaseTableList>
<ITEM>WideString</ITEM>
</DatabaseTableList>
<Result>Integer</Result>
</ANSWER>

DatabaseTableList TWideStringArray

A list of tables.

Result

Returns value from error code table.

GetObjectCount

Returns a count of objects in a object set.

<QUERY>
<MC_QUERY_NAME>GetObjectCount</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
</QUERY>

SessionID

Session identifier.

TableName

Table name.


<ANSWER>
<MC_ANSWER_NAME>GetObjectCount</MC_ANSWER_NAME>
<RecordCount>Integer</RecordCount>
<Result>Integer</Result>
</ANSWER>

RecordCount

A count of objects available.

Result

Returns value from error code table.

GetObjectFields

Returns a structure of object set currently opened.

<QUERY>
<MC_QUERY_NAME>GetObjectFields</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
</QUERY>

SessionID

Session identifier.

TableName

Table name.


<ANSWER>
<MC_ANSWER_NAME>GetObjectFields</MC_ANSWER_NAME>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FieldTypes>
<ITEM>Byte</ITEM>
</FieldTypes>
<FieldSize>
<ITEM>Integer</ITEM>
</FieldSize>
<FieldPrecision>
<ITEM>Integer</ITEM>
</FieldPrecision>
<FieldInfo>
<ITEM>Byte</ITEM>
</FieldInfo>
<FieldFunctions>
<ITEM>Byte</ITEM>
</FieldFunctions>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<GroupNames>
<ITEM>WideString</ITEM>
</GroupNames>
<GroupIcons>
<ITEM>BLOB</ITEM>
</GroupIcons>
<GroupIconsProperties>
<ITEM>
<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>
</ITEM>
</GroupIconsProperties>
<Result>Integer</Result>
</ANSWER>

FieldNames TWideStringArray

Names of object fields.

FieldTypes TDynamicByteArray

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

FieldSize TDynamicIntegerArray

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.

FieldPrecision TDynamicIntegerArray

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.

FieldInfo TDynamicByteArray

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

FieldFunctions TDynamicByteArray

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

GroupIDs TWideStringArray

A list of unique identifiers of all object groups in the object set.

GroupNames TWideStringArray

A list of names of all object groups in the object set.

GroupIcons TBlobArray

A list of object group icon bitmaps transferred as byte streams.

GroupIconsProperties TIconPropertiesArray

Properties of object group icons.

Result

Returns value from error code table.

SetObjectFields

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.

<QUERY>
<MC_QUERY_NAME>SetObjectFields</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FieldTypes>
<ITEM>Byte</ITEM>
</FieldTypes>
<FieldSize>
<ITEM>Integer</ITEM>
</FieldSize>
<FieldPrecision>
<ITEM>Integer</ITEM>
</FieldPrecision>
<FieldInfo>
<ITEM>Byte</ITEM>
</FieldInfo>
<FieldFunctions>
<ITEM>Byte</ITEM>
</FieldFunctions>
<FieldNewNames>
<ITEM>WideString</ITEM>
</FieldNewNames>
</QUERY>

SessionID

Session identifier.

FieldNames TWideStringArray

Names of object fields to be changed.

FieldTypes TDynamicByteArray

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

FieldSize TDynamicIntegerArray

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.

FieldPrecision TDynamicIntegerArray

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.

FieldInfo TDynamicByteArray

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

FieldFunctions TDynamicByteArray

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

FieldNewNames TWideStringArray

New names of corresponding object fields.


<ANSWER>
<MC_ANSWER_NAME>SetObjectFields</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

CreateObjectSet

Creates a new object set (requires administrative privileges).

<QUERY>
<MC_QUERY_NAME>CreateObjectSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AConnectionString>WideString</AConnectionString>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FieldTypes>
<ITEM>Byte</ITEM>
</FieldTypes>
<FieldSize>
<ITEM>Integer</ITEM>
</FieldSize>
<FieldPrecision>
<ITEM>Integer</ITEM>
</FieldPrecision>
<FieldInfo>
<ITEM>Byte</ITEM>
</FieldInfo>
<FieldFunctions>
<ITEM>Byte</ITEM>
</FieldFunctions>
<SaveToDisk>Boolean</SaveToDisk>
</QUERY>

SessionID

Session identifier.

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.

FieldNames TWideStringArray

Names of object fields.

FieldTypes TDynamicByteArray

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

FieldSize TDynamicIntegerArray

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.

FieldPrecision TDynamicIntegerArray

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.

FieldInfo TDynamicByteArray

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

FieldFunctions TDynamicByteArray

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

SaveToDisk

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


<ANSWER>
<MC_ANSWER_NAME>CreateObjectSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetObject

Returns all properties of an object identified by given ID.

<QUERY>
<MC_QUERY_NAME>GetObject</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

FieldNames TWideStringArray

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


<ANSWER>
<MC_ANSWER_NAME>GetObject</MC_ANSWER_NAME>
<FieldValues>
<ITEM>WideString</ITEM>
</FieldValues>
<ObjectPosition>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ObjectPosition>
<CaptionPosition>TCaptionPosition</CaptionPosition>
<Result>Integer</Result>
</ANSWER>

FieldValues TWideStringArray

Values for requested object fields.

ObjectPosition TObjectPosition

Object geographic data.

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

Result

Returns value from error code table.

EditObject

Locks object identified by given ID for changing.

<QUERY>
<MC_QUERY_NAME>EditObject</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.


<ANSWER>
<MC_ANSWER_NAME>EditObject</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

PostObject

Posts new data for object identified by given ID. The object should be locked by EditObject before. After success object will be unlocked.

<QUERY>
<MC_QUERY_NAME>PostObject</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<GroupID>TRecordID</GroupID>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FieldValues>
<ITEM>WideString</ITEM>
</FieldValues>
<ObjectPosition>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ObjectPosition>
<CaptionPosition>TCaptionPosition</CaptionPosition>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

GroupID

Object group identifier.

FieldNames TWideStringArray

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

FieldValues TWideStringArray

Values for corresponding object fields.

ObjectPosition TObjectPosition

Object geographic data.

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


<ANSWER>
<MC_ANSWER_NAME>PostObject</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

PostObjects

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

<QUERY>
<MC_QUERY_NAME>PostObjects</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FieldValues>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</FieldValues>
<ObjectPosition>
<ITEM>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ITEM>
</ObjectPosition>
<CaptionPosition>
<ITEM>TCaptionPosition</ITEM>
</CaptionPosition>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectIDs TWideStringArray

Object identifiers.

GroupIDs TWideStringArray

Object group identifiers.

FieldNames TWideStringArray

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

FieldValues TWideStringArrayArray

Values for corresponding objects and their fields.

ObjectPosition TObjectPositionArray

A list of object geographic datas.

CaptionPosition TCaptionPositionArray

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


<ANSWER>
<MC_ANSWER_NAME>PostObjects</MC_ANSWER_NAME>
<NotPostedIDs>
<ITEM>WideString</ITEM>
</NotPostedIDs>
<Result>Integer</Result>
</ANSWER>

NotPostedIDs TWideStringArray

A list of not posted objects (locked by other users or not existing).

Result

Returns value from error code table.

AppendObject

Inserts new object to the object set.

<QUERY>
<MC_QUERY_NAME>AppendObject</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FieldValues>
<ITEM>WideString</ITEM>
</FieldValues>
<ObjectPosition>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ObjectPosition>
<CaptionPosition>TCaptionPosition</CaptionPosition>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.

FieldNames TWideStringArray

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

FieldValues TWideStringArray

Values for corresponding object fields.

ObjectPosition TObjectPosition

Object geographic data.

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


<ANSWER>
<MC_ANSWER_NAME>AppendObject</MC_ANSWER_NAME>
<NewObjectID>TRecordID</NewObjectID>
<Result>Integer</Result>
</ANSWER>

NewObjectID

An identifier of the new object.

Result

Returns value from error code table.

AppendObjects

Inserts a set of new objects to the object set.

<QUERY>
<MC_QUERY_NAME>AppendObjects</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FieldValues>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</FieldValues>
<ObjectPosition>
<ITEM>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ITEM>
</ObjectPosition>
<CaptionPosition>
<ITEM>TCaptionPosition</ITEM>
</CaptionPosition>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupIDs TWideStringArray

Object group identifiers.

FieldNames TWideStringArray

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

FieldValues TWideStringArrayArray

Values for corresponding objects and their fields.

ObjectPosition TObjectPositionArray

A list of object geographic datas.

CaptionPosition TCaptionPositionArray

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


<ANSWER>
<MC_ANSWER_NAME>AppendObjects</MC_ANSWER_NAME>
<NewObjectIDs>
<ITEM>WideString</ITEM>
</NewObjectIDs>
<Result>Integer</Result>
</ANSWER>

NewObjectIDs TWideStringArray

A list of identifiers of the new objects.

Result

Returns value from error code table.

DeleteObject

Removes object identified by given ID.

<QUERY>
<MC_QUERY_NAME>DeleteObject</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.


<ANSWER>
<MC_ANSWER_NAME>DeleteObject</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

DeleteObjects

Rmoves objects identified by given IDs.

<QUERY>
<MC_QUERY_NAME>DeleteObjects</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectIDs TWideStringArray

Object identifiers.


<ANSWER>
<MC_ANSWER_NAME>DeleteObjects</MC_ANSWER_NAME>
<NotDeletedIDs>
<ITEM>WideString</ITEM>
</NotDeletedIDs>
<Result>Integer</Result>
</ANSWER>

NotDeletedIDs TWideStringArray

A list of not deleted objects (locked by other users or not existing).

Result

Returns value from error code table.

CancelEditObject

Unlocks object identified by given ID.

<QUERY>
<MC_QUERY_NAME>CancelEditObject</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.


<ANSWER>
<MC_ANSWER_NAME>CancelEditObject</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AppendObjectPolygon

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.

<QUERY>
<MC_QUERY_NAME>AppendObjectPolygon</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<MapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPoints>
<ShapeID>Integer</ShapeID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

MapPoints TLongLatPointArray

Geographical coordinates for vertices of the polygon.

ShapeID

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


<ANSWER>
<MC_ANSWER_NAME>AppendObjectPolygon</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetObjectPolygons

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

<QUERY>
<MC_QUERY_NAME>GetObjectPolygons</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<PolygonID>Integer</PolygonID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

PolygonID

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


<ANSWER>
<MC_ANSWER_NAME>GetObjectPolygons</MC_ANSWER_NAME>
<MapPoints>
<ITEM>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</ITEM>
</MapPoints>
<Result>Integer</Result>
</ANSWER>

MapPoints TLongLatPoint2DArray

Geographical coordinates of vertices of polygons.

Result

Returns value from error code table.

AppendObjectPolyline

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.

<QUERY>
<MC_QUERY_NAME>AppendObjectPolyline</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<MapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPoints>
<ShapeID>Integer</ShapeID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

MapPoints TLongLatPointArray

Geographical coordinates for vertices of the polyline.

ShapeID

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


<ANSWER>
<MC_ANSWER_NAME>AppendObjectPolyline</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetObjectPolylines

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

<QUERY>
<MC_QUERY_NAME>GetObjectPolylines</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<PolylineID>Integer</PolylineID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

PolylineID

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


<ANSWER>
<MC_ANSWER_NAME>GetObjectPolylines</MC_ANSWER_NAME>
<MapPoints>
<ITEM>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</ITEM>
</MapPoints>
<Result>Integer</Result>
</ANSWER>

MapPoints TLongLatPoint2DArray

Geographical coordinates of vertices of polygons.

Result

Returns value from error code table.

AppendObjectEllipse

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.

<QUERY>
<MC_QUERY_NAME>AppendObjectEllipse</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<MapRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</MapRect>
<ShapeID>Integer</ShapeID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

MapRect TLongLatRect

Geographical coordinates of a bounding rectangle of ellipse.

ShapeID

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


<ANSWER>
<MC_ANSWER_NAME>AppendObjectEllipse</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetObjectEllipses

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

<QUERY>
<MC_QUERY_NAME>GetObjectEllipses</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<EllipseID>Integer</EllipseID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

EllipseID

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


<ANSWER>
<MC_ANSWER_NAME>GetObjectEllipses</MC_ANSWER_NAME>
<MapRects>
<ITEM>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</ITEM>
</MapRects>
<Result>Integer</Result>
</ANSWER>

MapRects TLongLatRectArray

Geographical coordinates of a bounding rectangle of ellipses.

Result

Returns value from error code table.

AppendObjectRectangle

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.

<QUERY>
<MC_QUERY_NAME>AppendObjectRectangle</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<MapRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</MapRect>
<ShapeID>Integer</ShapeID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

MapRect TLongLatRect

Geographical coordinates of rectangle.

ShapeID

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


<ANSWER>
<MC_ANSWER_NAME>AppendObjectRectangle</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetObjectRectangles

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

<QUERY>
<MC_QUERY_NAME>GetObjectRectangles</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<RectangleID>Integer</RectangleID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

RectangleID

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


<ANSWER>
<MC_ANSWER_NAME>GetObjectRectangles</MC_ANSWER_NAME>
<MapRects>
<ITEM>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</ITEM>
</MapRects>
<Result>Integer</Result>
</ANSWER>

MapRects TLongLatRectArray

Geographical coordinates of rectangles.

Result

Returns value from error code table.

AppendObjectCircle

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.

<QUERY>
<MC_QUERY_NAME>AppendObjectCircle</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<MapPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MapPoint>
<MapRadius>Double</MapRadius>
<ShapeID>Integer</ShapeID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

MapPoint TLongLatPoint

Geographical coordinates of middle point.

MapRadius

Circle radius in meters.

ShapeID

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


<ANSWER>
<MC_ANSWER_NAME>AppendObjectCircle</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetObjectCircles

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

<QUERY>
<MC_QUERY_NAME>GetObjectCircles</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<CircleID>Integer</CircleID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

CircleID

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


<ANSWER>
<MC_ANSWER_NAME>GetObjectCircles</MC_ANSWER_NAME>
<MapPointArray>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPointArray>
<MapRadiusArray>
<ITEM>Double</ITEM>
</MapRadiusArray>
<Result>Integer</Result>
</ANSWER>

MapPointArray TLongLatPointArray

Geographical coordinates of middle points.

MapRadiusArray TFloatArray

Circle radiuses (in meters).

Result

Returns value from error code table.

DeleteObjectShape

Removes a shape from the shape list tied with object identified by given ID.

<QUERY>
<MC_QUERY_NAME>DeleteObjectShape</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<ShapeID>Integer</ShapeID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

ShapeID

Shape identifier. Value -1 means all shapes.


<ANSWER>
<MC_ANSWER_NAME>DeleteObjectShape</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetObjectBinaryData

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

<QUERY>
<MC_QUERY_NAME>GetObjectBinaryData</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.


<ANSWER>
<MC_ANSWER_NAME>GetObjectBinaryData</MC_ANSWER_NAME>
<BinaryData>BLOB</BinaryData>
<Result>Integer</Result>
</ANSWER>

BinaryData

Binary data.

Result

Returns value from error code table.

SetObjectBinaryData

Sets an arbitrary binary data for object identified by given ID.

<QUERY>
<MC_QUERY_NAME>SetObjectBinaryData</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<BinaryData>BLOB</BinaryData>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

BinaryData

Binary data.


<ANSWER>
<MC_ANSWER_NAME>SetObjectBinaryData</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetGroupBinaryData

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

<QUERY>
<MC_QUERY_NAME>GetGroupBinaryData</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.


<ANSWER>
<MC_ANSWER_NAME>GetGroupBinaryData</MC_ANSWER_NAME>
<BinaryData>BLOB</BinaryData>
<Result>Integer</Result>
</ANSWER>

BinaryData

Binary data.

Result

Returns value from error code table.

SetGroupBinaryData

Sets an arbitrary binary data for object group identified by given ID.

<QUERY>
<MC_QUERY_NAME>SetGroupBinaryData</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
<BinaryData>BLOB</BinaryData>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.

BinaryData

Binary data.


<ANSWER>
<MC_ANSWER_NAME>SetGroupBinaryData</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetGroupSettings

Returns settings of an object group.

<QUERY>
<MC_QUERY_NAME>GetGroupSettings</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.


<ANSWER>
<MC_ANSWER_NAME>GetGroupSettings</MC_ANSWER_NAME>
<GroupSettings>
<GroupName>WideString</GroupName>
<IconVisible>Boolean</IconVisible>
<IconID>Integer</IconID>
<IconSize>Integer</IconSize>
<IconFillSign>Boolean</IconFillSign>
<IconColor>TColor</IconColor>
<IconBorderSize>Integer</IconBorderSize>
<IconBorderColor>TColor</IconBorderColor>
<IconZoomMin>Double</IconZoomMin>
<IconZoomMax>Double</IconZoomMax>
<NameVisible>Boolean</NameVisible>
<NameFont>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</NameFont>
<NameZoomMin>Double</NameZoomMin>
<NameZoomMax>Double</NameZoomMax>
</GroupSettings>
<VisibleFields>
<ITEM>WideString</ITEM>
</VisibleFields>
<Result>Integer</Result>
</ANSWER>

GroupSettings TGroupSettings

Visual settings of an object group.

VisibleFields TWideStringArray

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

Result

Returns value from error code table.

GetGroupShapeSettings

Returns settings of an object group concerning shape visualization.

<QUERY>
<MC_QUERY_NAME>GetGroupShapeSettings</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.


<ANSWER>
<MC_ANSWER_NAME>GetGroupShapeSettings</MC_ANSWER_NAME>
<GroupShapeSettings>
<ShapeVisible>Boolean</ShapeVisible>
<ShapeUnderMap>Boolean</ShapeUnderMap>
<ShapeFill>Boolean</ShapeFill>
<ShapeColor>TColor</ShapeColor>
<ShapeBorderSize>Integer</ShapeBorderSize>
<ShapeBorderColor>TColor</ShapeBorderColor>
<ShapeZoomMin>Double</ShapeZoomMin>
<ShapeZoomMax>Double</ShapeZoomMax>
</GroupShapeSettings>
<Result>Integer</Result>
</ANSWER>

GroupShapeSettings TGroupShapeSettings

Visual shape settings of object group.

Result

Returns value from error code table.

SetGroupShapeSettings

Sets settings of an object group concerning shape visualization.

<QUERY>
<MC_QUERY_NAME>SetGroupShapeSettings</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
<GroupShapeSettings>
<ShapeVisible>Boolean</ShapeVisible>
<ShapeUnderMap>Boolean</ShapeUnderMap>
<ShapeFill>Boolean</ShapeFill>
<ShapeColor>TColor</ShapeColor>
<ShapeBorderSize>Integer</ShapeBorderSize>
<ShapeBorderColor>TColor</ShapeBorderColor>
<ShapeZoomMin>Double</ShapeZoomMin>
<ShapeZoomMax>Double</ShapeZoomMax>
</GroupShapeSettings>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.

GroupShapeSettings TGroupShapeSettings

Visual shape settings of object group.


<ANSWER>
<MC_ANSWER_NAME>SetGroupShapeSettings</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

SetVisibleGroups

Sets the visibility on maps for object groups.

<QUERY>
<MC_QUERY_NAME>SetVisibleGroups</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupIDs TWideStringArray

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.


<ANSWER>
<MC_ANSWER_NAME>SetVisibleGroups</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetVisibleGroups

Returns object group visibility.

<QUERY>
<MC_QUERY_NAME>GetVisibleGroups</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
</QUERY>

SessionID

Session identifier.

TableName

Table name.


<ANSWER>
<MC_ANSWER_NAME>GetVisibleGroups</MC_ANSWER_NAME>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<Result>Integer</Result>
</ANSWER>

GroupIDs TWideStringArray

A list of object group identifiers currently shown on maps.

Result

Returns value from error code table.

EditGroup

Locks an object group for changing.

<QUERY>
<MC_QUERY_NAME>EditGroup</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.


<ANSWER>
<MC_ANSWER_NAME>EditGroup</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

PostGroup

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.

<QUERY>
<MC_QUERY_NAME>PostGroup</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
<GroupSettings>
<GroupName>WideString</GroupName>
<IconVisible>Boolean</IconVisible>
<IconID>Integer</IconID>
<IconSize>Integer</IconSize>
<IconFillSign>Boolean</IconFillSign>
<IconColor>TColor</IconColor>
<IconBorderSize>Integer</IconBorderSize>
<IconBorderColor>TColor</IconBorderColor>
<IconZoomMin>Double</IconZoomMin>
<IconZoomMax>Double</IconZoomMax>
<NameVisible>Boolean</NameVisible>
<NameFont>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</NameFont>
<NameZoomMin>Double</NameZoomMin>
<NameZoomMax>Double</NameZoomMax>
</GroupSettings>
<VisibleFields>
<ITEM>WideString</ITEM>
</VisibleFields>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.

GroupSettings TGroupSettings

Visual settings of the object group.

VisibleFields TWideStringArray

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


<ANSWER>
<MC_ANSWER_NAME>PostGroup</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

AppendGroup

Inserts new object group to the object set.

<QUERY>
<MC_QUERY_NAME>AppendGroup</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupSettings>
<GroupName>WideString</GroupName>
<IconVisible>Boolean</IconVisible>
<IconID>Integer</IconID>
<IconSize>Integer</IconSize>
<IconFillSign>Boolean</IconFillSign>
<IconColor>TColor</IconColor>
<IconBorderSize>Integer</IconBorderSize>
<IconBorderColor>TColor</IconBorderColor>
<IconZoomMin>Double</IconZoomMin>
<IconZoomMax>Double</IconZoomMax>
<NameVisible>Boolean</NameVisible>
<NameFont>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</NameFont>
<NameZoomMin>Double</NameZoomMin>
<NameZoomMax>Double</NameZoomMax>
</GroupSettings>
<VisibleFields>
<ITEM>WideString</ITEM>
</VisibleFields>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupSettings TGroupSettings

Visual settings of the object group.

VisibleFields TWideStringArray

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


<ANSWER>
<MC_ANSWER_NAME>AppendGroup</MC_ANSWER_NAME>
<NewGroupID>TRecordID</NewGroupID>
<Result>Integer</Result>
</ANSWER>

NewGroupID

Identifier of a new object group.

Result

Returns value from error code table.

DeleteGroup

Removes object group identified by given ID.

<QUERY>
<MC_QUERY_NAME>DeleteGroup</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.


<ANSWER>
<MC_ANSWER_NAME>DeleteGroup</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

CancelEditGroup

Unlocks object group identified by given ID.

<QUERY>
<MC_QUERY_NAME>CancelEditGroup</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.


<ANSWER>
<MC_ANSWER_NAME>CancelEditGroup</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetGroupIcon

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

<QUERY>
<MC_QUERY_NAME>GetGroupIcon</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupID>TRecordID</GroupID>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupID

Object group identifier.


<ANSWER>
<MC_ANSWER_NAME>GetGroupIcon</MC_ANSWER_NAME>
<GroupIcon>BLOB</GroupIcon>
<GroupIconProperties>
<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>
</GroupIconProperties>
<Result>Integer</Result>
</ANSWER>

GroupIcon

Resultant icon transferred as a byte stream.

GroupIconProperties TIconProperties

Icon properties.

Result

Returns value from error code table.

AddGroupIcon

Adds new icon to the object set.

<QUERY>
<MC_QUERY_NAME>AddGroupIcon</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DatabaseType>WideString</DatabaseType>
<GroupIcon>BLOB</GroupIcon>
<GroupIconProperties>
<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>
</GroupIconProperties>
</QUERY>

SessionID

Session identifier.

DatabaseType

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

GroupIcon

Icon transferred as a byte stream.

GroupIconProperties TIconProperties

Icon properties.


<ANSWER>
<MC_ANSWER_NAME>AddGroupIcon</MC_ANSWER_NAME>
<NewIconID>Integer</NewIconID>
<Result>Integer</Result>
</ANSWER>

NewIconID

Identifier of an icon added.

Result

Returns value from error code table.

DeleteGroupIcon

Removes an icon from the object set.

<QUERY>
<MC_QUERY_NAME>DeleteGroupIcon</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DatabaseType>WideString</DatabaseType>
<IconID>Integer</IconID>
</QUERY>

SessionID

Session identifier.

DatabaseType

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

IconID

Icon identifier.


<ANSWER>
<MC_ANSWER_NAME>DeleteGroupIcon</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetGroupIcons

Returns a list of all icons stored in a database.

<QUERY>
<MC_QUERY_NAME>GetGroupIcons</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DatabaseType>WideString</DatabaseType>
</QUERY>

SessionID

Session identifier.

DatabaseType

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


<ANSWER>
<MC_ANSWER_NAME>GetGroupIcons</MC_ANSWER_NAME>
<GroupIcons>
<ITEM>BLOB</ITEM>
</GroupIcons>
<GroupIconsProperties>
<ITEM>
<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>
</ITEM>
</GroupIconsProperties>
<Result>Integer</Result>
</ANSWER>

GroupIcons TBlobArray

A list of object group icon bitmaps transferred as byte streams.

GroupIconsProperties TIconPropertiesArray

Properties of object group icons.

Result

Returns value from error code table.

CheckUpdate

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

<QUERY>
<MC_QUERY_NAME>CheckUpdate</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
</QUERY>

SessionID

Session identifier.

TableName

Table name.


<ANSWER>
<MC_ANSWER_NAME>CheckUpdate</MC_ANSWER_NAME>
<ModifiedObjectCount>Integer</ModifiedObjectCount>
<RemovedObjectCount>Integer</RemovedObjectCount>
<ModifiedGroups>
<ITEM>Integer</ITEM>
</ModifiedGroups>
<ModifiedIcons>Boolean</ModifiedIcons>
<Result>Integer</Result>
</ANSWER>

ModifiedObjectCount

Number of objects changed. A list of them may be obtained using GetNextResult_UpdatedSet function.

RemovedObjectCount

Number of objects removed. A list of them may be obtained using GetNextResult_RemovedSet function.

ModifiedGroups TDynamicIntegerArray

Identifiers of changed object groups.

ModifiedIcons

Indicates whether a list of icons stored into database was changed.

Result

Returns value from error code table.

GetModifiedFields

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

<QUERY>
<MC_QUERY_NAME>GetModifiedFields</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>GetModifiedFields</MC_ANSWER_NAME>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<Result>Integer</Result>
</ANSWER>

FieldNames TWideStringArray

A list of field names.

Result

Returns value from error code table.

GetRemovedFields

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

<QUERY>
<MC_QUERY_NAME>GetRemovedFields</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>GetRemovedFields</MC_ANSWER_NAME>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<Result>Integer</Result>
</ANSWER>

FieldNames TWideStringArray

A list of field names.

Result

Returns value from error code table.

FilterByText

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.

<QUERY>
<MC_QUERY_NAME>FilterByText</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FieldValues>
<ITEM>WideString</ITEM>
</FieldValues>
<Conditions>
<ITEM>WideString</ITEM>
</Conditions>
<Limit>Integer</Limit>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

FieldNames TWideStringArray

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

FieldValues TWideStringArray

Values being searched in condition fields.

Conditions TWideStringArray

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.

Limit

Result limitation.


<ANSWER>
<MC_ANSWER_NAME>FilterByText</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

Count of objects found.

Result

Returns value from error code table.

FilterByPoint

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.

<QUERY>
<MC_QUERY_NAME>FilterByPoint</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<Limit>Integer</Limit>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

MiddlePoint TLongLatPoint

Geographic coordinates of search middle point.

Limit

Result limitation.


<ANSWER>
<MC_ANSWER_NAME>FilterByPoint</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

Count of objects found.

Result

Returns value from error code table.

FilterByRadius

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.

<QUERY>
<MC_QUERY_NAME>FilterByRadius</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<MiddlePoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePoint>
<Radius>Integer</Radius>
<Limit>Integer</Limit>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

MiddlePoint TLongLatPoint

Geographic coordinates of search middle point.

Radius

Search radius (in meters).

Limit

Result limitation.


<ANSWER>
<MC_ANSWER_NAME>FilterByRadius</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

Count of objects found.

Result

Returns value from error code table.

FilterByObjectShape

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.

<QUERY>
<MC_QUERY_NAME>FilterByObjectShape</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectID>TRecordID</ObjectID>
<ShapeID>Integer</ShapeID>
<Limit>Integer</Limit>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectID

Object identifier.

ShapeID

Shape identifier.

Limit

Result limitation.


<ANSWER>
<MC_ANSWER_NAME>FilterByObjectShape</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

Count of objects found.

Result

Returns value from error code table.

FilterByShape

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.

<QUERY>
<MC_QUERY_NAME>FilterByShape</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<MapPointArray>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</MapPointArray>
<Limit>Integer</Limit>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

MapPointArray TLongLatPointArray

Geographical coordinates for vertices of the shape.

Limit

Result limitation.


<ANSWER>
<MC_ANSWER_NAME>FilterByShape</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

Count of objects found.

Result

Returns value from error code table.

GetNextResult_FieldSet

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

<QUERY>
<MC_QUERY_NAME>GetNextResult_FieldSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
<FieldName>WideString</FieldName>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectIDs TWideStringArray

List of identifiers of requested objects.

FieldName

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


<ANSWER>
<MC_ANSWER_NAME>GetNextResult_FieldSet</MC_ANSWER_NAME>
<FieldValues>
<ITEM>WideString</ITEM>
</FieldValues>
<NotFoundIDs>
<ITEM>WideString</ITEM>
</NotFoundIDs>
<Result>Integer</Result>
</ANSWER>

FieldValues TWideStringArray

Resultant field values.

NotFoundIDs TWideStringArray

List of identifiers of objects missed.

Result

Returns value from error code table.

GetNextResult_IDSet

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

<QUERY>
<MC_QUERY_NAME>GetNextResult_IDSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<Limit>Integer</Limit>
<FromBeginning>Boolean</FromBeginning>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

Limit

Requested object count.

FromBeginning

Option of getting objects from beginning of the object set.


<ANSWER>
<MC_ANSWER_NAME>GetNextResult_IDSet</MC_ANSWER_NAME>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<Result>Integer</Result>
</ANSWER>

ObjectIDs TWideStringArray

Resultant object identifiers.

GroupIDs TWideStringArray

Resultant object group identifiers.

Result

Returns value from error code table.

GetNextResult_PositionSet

Returns geographic information for given part of the object set.

<QUERY>
<MC_QUERY_NAME>GetNextResult_PositionSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectIDs TWideStringArray

List of identifiers of requested objects.


<ANSWER>
<MC_ANSWER_NAME>GetNextResult_PositionSet</MC_ANSWER_NAME>
<ObjectPositions>
<ITEM>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ITEM>
</ObjectPositions>
<CaptionPositions>
<ITEM>TCaptionPosition</ITEM>
</CaptionPositions>
<NotFoundIDs>
<ITEM>WideString</ITEM>
</NotFoundIDs>
<Result>Integer</Result>
</ANSWER>

ObjectPositions TObjectPositionArray

Geographic information for requested objects.

CaptionPositions TCaptionPositionArray

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

NotFoundIDs TWideStringArray

List of identifiers of objects missed.

Result

Returns value from error code table.

GetNextResult_Set

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.

<QUERY>
<MC_QUERY_NAME>GetNextResult_Set</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<Limit>Integer</Limit>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
<FromBeginning>Boolean</FromBeginning>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

Limit

Requested object count.

FieldNames TWideStringArray

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

FromBeginning

Option of getting objects from beginning of the object set.


<ANSWER>
<MC_ANSWER_NAME>GetNextResult_Set</MC_ANSWER_NAME>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<ObjectPositions>
<ITEM>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ITEM>
</ObjectPositions>
<CaptionPositions>
<ITEM>TCaptionPosition</ITEM>
</CaptionPositions>
<FieldValuesArray>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</FieldValuesArray>
<Result>Integer</Result>
</ANSWER>

ObjectIDs TWideStringArray

Resultant object identifiers.

GroupIDs TWideStringArray

Resultant object group identifiers.

ObjectPositions TObjectPositionArray

Geographic information for requested objects.

CaptionPositions TCaptionPositionArray

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

FieldValuesArray TWideStringArrayArray

Resultant field values.

Result

Returns value from error code table.

GetNextResult_UpdatedSet

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.

<QUERY>
<MC_QUERY_NAME>GetNextResult_UpdatedSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<Limit>Integer</Limit>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

Limit

Requested object count.

FieldNames TWideStringArray

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


<ANSWER>
<MC_ANSWER_NAME>GetNextResult_UpdatedSet</MC_ANSWER_NAME>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<ObjectPositions>
<ITEM>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ITEM>
</ObjectPositions>
<CaptionPositions>
<ITEM>TCaptionPosition</ITEM>
</CaptionPositions>
<FieldValuesArray>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</FieldValuesArray>
<Result>Integer</Result>
</ANSWER>

ObjectIDs TWideStringArray

Resultant object identifiers.

GroupIDs TWideStringArray

Resultant object group identifiers.

ObjectPositions TObjectPositionArray

Geographic information for requested objects.

CaptionPositions TCaptionPositionArray

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

FieldValuesArray TWideStringArrayArray

Resultant field values.

Result

Returns value from error code table.

GetNextResult_RemovedSet

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

<QUERY>
<MC_QUERY_NAME>GetNextResult_RemovedSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<Limit>Integer</Limit>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

Limit

Requested object count.


<ANSWER>
<MC_ANSWER_NAME>GetNextResult_RemovedSet</MC_ANSWER_NAME>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
<Result>Integer</Result>
</ANSWER>

ObjectIDs TWideStringArray

Resultant object identifiers.

Result

Returns value from error code table.

SetObjectIDs

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.

<QUERY>
<MC_QUERY_NAME>SetObjectIDs</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
<AllowSelected>Boolean</AllowSelected>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

ObjectIDs TWideStringArray

Object identifier list.

AllowSelected

Indicates whether given objects should be left (true) or filtered out (false).


<ANSWER>
<MC_ANSWER_NAME>SetObjectIDs</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetObjectAggregates

Returns aggregate values for object fields.

<QUERY>
<MC_QUERY_NAME>GetObjectAggregates</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<FieldNames>
<ITEM>WideString</ITEM>
</FieldNames>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

FieldNames TWideStringArray

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


<ANSWER>
<MC_ANSWER_NAME>GetObjectAggregates</MC_ANSWER_NAME>
<FieldSum>
<ITEM>WideString</ITEM>
</FieldSum>
<FieldMin>
<ITEM>WideString</ITEM>
</FieldMin>
<FieldMax>
<ITEM>WideString</ITEM>
</FieldMax>
<FieldAvg>
<ITEM>WideString</ITEM>
</FieldAvg>
<FieldNull>
<ITEM>WideString</ITEM>
</FieldNull>
<Result>Integer</Result>
</ANSWER>

FieldSum TWideStringArray

A list of sum values for requested fields. Empty strings are returned for non-numeric fields.

FieldMin TWideStringArray

A list of minimal values for requested fields.

FieldMax TWideStringArray

A list of maximal values for requested fields.

FieldAvg TWideStringArray

A list of average values for requested fields. Empty strings are returned for non-numeric fields.

FieldNull TWideStringArray

A list of empty value counters for requested fields.

Result

Returns value from error code table.

ClearSetFilter

Disables all filters performed on the object set by the server session. All objects are available from now.

<QUERY>
<MC_QUERY_NAME>ClearSetFilter</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
</QUERY>

SessionID

Session identifier.

TableName

Table name.


<ANSWER>
<MC_ANSWER_NAME>ClearSetFilter</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

EditObjectFields

Locks the currently opened object set for restructuring (requires administrative privileges).

<QUERY>
<MC_QUERY_NAME>EditObjectFields</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>EditObjectFields</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

CancelEditObjectFields

Unlocks the currently opened object set locked by EditObjectFields function (requires administrative privileges).

<QUERY>
<MC_QUERY_NAME>CancelEditObjectFields</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>CancelEditObjectFields</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

GetAggregatedObjectShapes

Returns identifiers of objects with shapes containing given objects.

<QUERY>
<MC_QUERY_NAME>GetAggregatedObjectShapes</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupIDs TWideStringArray

Identifiers of object groups being searched.

ObjectIDs TWideStringArray

Identifiers of given objects.


<ANSWER>
<MC_ANSWER_NAME>GetAggregatedObjectShapes</MC_ANSWER_NAME>
<AggregatedIDs>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</AggregatedIDs>
<Result>Integer</Result>
</ANSWER>

AggregatedIDs TWideStringArrayArray

Resultant object identifiers.

Result

Returns value from error code table.

GetAggregatedObjects

Returns identifiers of objects contained in shapes of given objects.

<QUERY>
<MC_QUERY_NAME>GetAggregatedObjects</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<TableName>WideString</TableName>
<GroupIDs>
<ITEM>WideString</ITEM>
</GroupIDs>
<ObjectIDs>
<ITEM>WideString</ITEM>
</ObjectIDs>
</QUERY>

SessionID

Session identifier.

TableName

Table name.

GroupIDs TWideStringArray

Identifiers of object groups being searched.

ObjectIDs TWideStringArray

Identifiers of given objects.


<ANSWER>
<MC_ANSWER_NAME>GetAggregatedObjects</MC_ANSWER_NAME>
<AggregatedIDs>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</AggregatedIDs>
<Aggregated>
<ITEM>Boolean</ITEM>
</Aggregated>
<Result>Integer</Result>
</ANSWER>

AggregatedIDs TWideStringArrayArray

Resultant object identifiers.

Aggregated TBooleanArray

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).

Result

Returns value from error code table.

SearchInitialize

Clears a search context in the given server session and initializes required search mode of the searching.

<QUERY>
<MC_QUERY_NAME>SearchInitialize</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ASCIISearch>Boolean</ASCIISearch>
</QUERY>

SessionID

Session identifier.

ASCIISearch

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


<ANSWER>
<MC_ANSWER_NAME>SearchInitialize</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

SearchGetCountryList

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

<QUERY>
<MC_QUERY_NAME>SearchGetCountryList</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>SearchGetCountryList</MC_ANSWER_NAME>
<CountryNames>
<ITEM>WideString</ITEM>
</CountryNames>
<Result>Integer</Result>
</ANSWER>

CountryNames TWideStringArray

The list of countries.

Result

Returns value from error code table.

SearchSelectCities

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.

<QUERY>
<MC_QUERY_NAME>SearchSelectCities</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Country>Integer</Country>
<Prefix>WideString</Prefix>
<ZIP>WideString</ZIP>
<Adm1>WideString</Adm1>
<Adm2>WideString</Adm2>
<Adm3>WideString</Adm3>
</QUERY>

SessionID

Session identifier.

Country

The number of country being an index in the list returned by SearchGetCountryList function. Value 0 (the first index) corresponds to "any country".

Prefix

A phrase being searched at the beginning of city names. The phrase may be empty to obtain all cities.

ZIP

Postal code.

Adm1

The name of 2nd level administrative area, i.e. a county.

Adm2

The name of 3rd level administrative area, i.e. a district.

Adm3

The name of 4th level administrative area.


<ANSWER>
<MC_ANSWER_NAME>SearchSelectCities</MC_ANSWER_NAME>
<ResultCount>Integer</ResultCount>
<Result>Integer</Result>
</ANSWER>

ResultCount

The count of found cities.

Result

Returns value from error code table.

SearchGetCityList

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

<QUERY>
<MC_QUERY_NAME>SearchGetCityList</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<First>Integer</First>
<Count>Integer</Count>
</QUERY>

SessionID

Session identifier.

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.

Count

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


<ANSWER>
<MC_ANSWER_NAME>SearchGetCityList</MC_ANSWER_NAME>
<CityNames>
<ITEM>WideString</ITEM>
</CityNames>
<CityAdmAbbrev>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</CityAdmAbbrev>
<CityAdmNames>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</CityAdmNames>
<Result>Integer</Result>
</ANSWER>

CityNames TWideStringArray

The list of found cities.

CityAdmAbbrev TWideStringArrayArray

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.

CityAdmNames TWideStringArrayArray

The list of administrative regions containing found cities. Country and lower level area names are returned for each city as a list of strings.

Result

Returns value from error code table.

SearchGetCityListEx

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

<QUERY>
<MC_QUERY_NAME>SearchGetCityListEx</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<First>Integer</First>
<Count>Integer</Count>
</QUERY>

SessionID

Session identifier.

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.

Count

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


<ANSWER>
<MC_ANSWER_NAME>SearchGetCityListEx</MC_ANSWER_NAME>
<CityNames>
<ITEM>WideString</ITEM>
</CityNames>
<CityAdmAbbrev>
<ITEM>WideString</ITEM>
</CityAdmAbbrev>
<CityAdmNames>
<ITEM>WideString</ITEM>
</CityAdmNames>
<Result>Integer</Result>
</ANSWER>

CityNames TWideStringArray

The list of found cities.

CityAdmAbbrev TWideStringArray

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 '|'.

CityAdmNames TWideStringArray

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 '|'.

Result

Returns value from error code table.

SearchGetItemKindList

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

<QUERY>
<MC_QUERY_NAME>SearchGetItemKindList</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>SearchGetItemKindList</MC_ANSWER_NAME>
<ItemKindNames>
<ITEM>WideString</ITEM>
</ItemKindNames>
<Result>Integer</Result>
</ANSWER>

ItemKindNames TWideStringArray

The list of element kinds. Currenty the list contains: squares, estates, quarters, highway exits, airports, roads, rivers, lakes, cemeteries, parks.

Result

Returns value from error code table.

SearchSetItemsFilter

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.

<QUERY>
<MC_QUERY_NAME>SearchSetItemsFilter</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ItemKinds>
<ITEM>Integer</ITEM>
</ItemKinds>
</QUERY>

SessionID

Session identifier.

ItemKinds TDynamicIntegerArray

The list of element kind indices (only indices returned by SearchGetItemKindList function are permitted).


<ANSWER>
<MC_ANSWER_NAME>SearchSetItemsFilter</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

SearchSelectItems

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.

<QUERY>
<MC_QUERY_NAME>SearchSelectItems</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<CityIndex>Integer</CityIndex>
<ItemKindIndex>Integer</ItemKindIndex>
<Prefix>WideString</Prefix>
</QUERY>

SessionID

Session identifier.

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.

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".

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.


<ANSWER>
<MC_ANSWER_NAME>SearchSelectItems</MC_ANSWER_NAME>
<ResultCount>Integer</ResultCount>
<Result>Integer</Result>
</ANSWER>

ResultCount

The count of found elements.

Result

Returns value from error code table.

SearchSelectItemsEx

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.

<QUERY>
<MC_QUERY_NAME>SearchSelectItemsEx</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Country>Integer</Country>
<ItemKindIndex>Integer</ItemKindIndex>
<Prefix>WideString</Prefix>
</QUERY>

SessionID

Session identifier.

Country

The number of country being an index in the list returned by SearchGetCountryList function. Value 0 (the first index) corresponds to "any country".

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".

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.


<ANSWER>
<MC_ANSWER_NAME>SearchSelectItemsEx</MC_ANSWER_NAME>
<ResultCount>Integer</ResultCount>
<Result>Integer</Result>
</ANSWER>

ResultCount

The count of found elements.

Result

Returns value from error code table.

SearchGetItemsList

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.

<QUERY>
<MC_QUERY_NAME>SearchGetItemsList</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<First>Integer</First>
<Count>Integer</Count>
</QUERY>

SessionID

Session identifier.

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.

Count

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


<ANSWER>
<MC_ANSWER_NAME>SearchGetItemsList</MC_ANSWER_NAME>
<ItemNames>
<ITEM>WideString</ITEM>
</ItemNames>
<ItemTypes>
<ITEM>Integer</ITEM>
</ItemTypes>
<Result>Integer</Result>
</ANSWER>

ItemNames TWideStringArray

The list of found map elements.

ItemTypes TDynamicIntegerArray

The list of corresponding element kinds being indices in the list returned by SearchGetItemKindList function.

Result

Returns value from error code table.

SearchAddCityToSelection

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.

<QUERY>
<MC_QUERY_NAME>SearchAddCityToSelection</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<CityNum>Integer</CityNum>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>SearchAddCityToSelection</MC_ANSWER_NAME>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<MidPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MidPoint>
<Result>Integer</Result>
</ANSWER>

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the city area.

MidPoint TLongLatPoint

The middle point of the city.

Result

Returns value from error code table.

SearchAddObjectToSelection

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.

<QUERY>
<MC_QUERY_NAME>SearchAddObjectToSelection</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ObjectNum>Integer</ObjectNum>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>SearchAddObjectToSelection</MC_ANSWER_NAME>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<MidPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MidPoint>
<Result>Integer</Result>
</ANSWER>

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the area of the map element.

MidPoint TLongLatPoint

The middle point of the element.

Result

Returns value from error code table.

SearchAddStreetWithNumToSelection

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.

<QUERY>
<MC_QUERY_NAME>SearchAddStreetWithNumToSelection</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<StreetNum>Integer</StreetNum>
<Numeration>WideString</Numeration>
</QUERY>

SessionID

Session identifier.

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".

Numeration

Building number to be found.


<ANSWER>
<MC_ANSWER_NAME>SearchAddStreetWithNumToSelection</MC_ANSWER_NAME>
<MidPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MidPoint>
<Result>Integer</Result>
</ANSWER>

MidPoint TLongLatPoint

Geographic coordinates of found point.

Result

Returns value from error code table.

SearchGetStreetHandle

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.

<QUERY>
<MC_QUERY_NAME>SearchGetStreetHandle</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<StreetNum>Integer</StreetNum>
</QUERY>

SessionID

Session identifier.

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".


<ANSWER>
<MC_ANSWER_NAME>SearchGetStreetHandle</MC_ANSWER_NAME>
<StreetHandle>Integer</StreetHandle>
<Result>Integer</Result>
</ANSWER>

StreetHandle

A handle to the element.

Result

Returns value from error code table.

SearchAddStreetCrossingToSelection

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.

<QUERY>
<MC_QUERY_NAME>SearchAddStreetCrossingToSelection</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<StreetHandleA>Integer</StreetHandleA>
<StreetHandleB>Integer</StreetHandleB>
</QUERY>

SessionID

Session identifier.

StreetHandleA

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

StreetHandleB

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


<ANSWER>
<MC_ANSWER_NAME>SearchAddStreetCrossingToSelection</MC_ANSWER_NAME>
<MidPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MidPoint>
<Result>Integer</Result>
</ANSWER>

MidPoint TLongLatPoint

Geographic coordinates of found crossing point.

Result

Returns value from error code table.

Geocode

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

<QUERY>
<MC_QUERY_NAME>Geocode</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ASCIISearch>Boolean</ASCIISearch>
<Points>
<ITEM>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
</ITEM>
</Points>
</QUERY>

SessionID

Session identifier.

ASCIISearch

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

Points TGeocodePointInfoArray

A list of addresses to be geocoded.


<ANSWER>
<MC_ANSWER_NAME>Geocode</MC_ANSWER_NAME>
<GeocodeLevel>
<ITEM>Byte</ITEM>
</GeocodeLevel>
<Positions>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Positions>
<Result>Integer</Result>
</ANSWER>

GeocodeLevel TDynamicByteArray

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).

Positions TLongLatPointArray

A list of resultant geographic coordinates.

Result

Returns value from error code table.

GeocodeEx

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.

<QUERY>
<MC_QUERY_NAME>GeocodeEx</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ASCIISearch>Boolean</ASCIISearch>
<Point>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<Commune>WideString</Commune>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
</Point>
<MaxResultCount>Integer</MaxResultCount>
</QUERY>

SessionID

Session identifier.

ASCIISearch

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

Point TGeocodePointInfoEx

An address to be geocoded.

MaxResultCount

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


<ANSWER>
<MC_ANSWER_NAME>GeocodeEx</MC_ANSWER_NAME>
<Points>
<ITEM>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<Commune>WideString</Commune>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
</ITEM>
</Points>
<GeocodeLevel>
<ITEM>Byte</ITEM>
</GeocodeLevel>
<Positions>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Positions>
<BoundingRects>
<ITEM>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</ITEM>
</BoundingRects>
<Result>Integer</Result>
</ANSWER>

Points TGeocodePointInfoExArray

Proposed resultant addresses.

GeocodeLevel TDynamicByteArray

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).

Positions TLongLatPointArray

A list of resultant geographic coordinates.

BoundingRects TLongLatRectArray

Geographic coordinates of the rectangles bounding objects found.

Result

Returns value from error code table.

MultiGeocodeEx

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.

<QUERY>
<MC_QUERY_NAME>MultiGeocodeEx</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ASCIISearch>Boolean</ASCIISearch>
<InputPoints>
<ITEM>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<Commune>WideString</Commune>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
</ITEM>
</InputPoints>
<MaxResultCount>Integer</MaxResultCount>
</QUERY>

SessionID

Session identifier.

ASCIISearch

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

InputPoints TGeocodePointInfoExArray

An address to be geocoded.

MaxResultCount

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


<ANSWER>
<MC_ANSWER_NAME>MultiGeocodeEx</MC_ANSWER_NAME>
<OutputPoints>
<ITEM>
<SourceIndex>Integer</SourceIndex>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<Commune>WideString</Commune>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
<GeocodeLevel>Byte</GeocodeLevel>
<Position>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</Position>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
</ITEM>
</OutputPoints>
<Result>Integer</Result>
</ANSWER>

OutputPoints TMultiGeocodePointInfoExArray

Proposed resultant addresses.

Result

Returns value from error code table.

LocalizeNumFieldsGet

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

<QUERY>
<MC_QUERY_NAME>LocalizeNumFieldsGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeNumFieldsGet</MC_ANSWER_NAME>
<Name>WideString</Name>
<ShowOnInfo>Boolean</ShowOnInfo>
<Result>Integer</Result>
</ANSWER>

Name

Field name.

ShowOnInfo

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

Result

Returns value from error code table.

LocalizeNumFieldsSet

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

<QUERY>
<MC_QUERY_NAME>LocalizeNumFieldsSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
<Name>WideString</Name>
<ShowOnInfo>Boolean</ShowOnInfo>
</QUERY>

SessionID

Session identifier.

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.

Name

Field name.

ShowOnInfo

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


<ANSWER>
<MC_ANSWER_NAME>LocalizeNumFieldsSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeNumFieldsAdd

Adds a new field to the numeric fields collection saved in the server session. The field is appended at the end of the collection.

<QUERY>
<MC_QUERY_NAME>LocalizeNumFieldsAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Name>WideString</Name>
<ShowOnInfo>Boolean</ShowOnInfo>
</QUERY>

SessionID

Session identifier.

Name

Field name.

ShowOnInfo

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


<ANSWER>
<MC_ANSWER_NAME>LocalizeNumFieldsAdd</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeNumFieldsRemove

Removes a field from the numeric fields collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeNumFieldsRemove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeNumFieldsRemove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeNumFieldsClear

Removes all fields from the numeric fields collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeNumFieldsClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeNumFieldsClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeNumFieldsGetCount

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

<QUERY>
<MC_QUERY_NAME>LocalizeNumFieldsGetCount</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeNumFieldsGetCount</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

The number of fields in a collection.

Result

Returns value from error code table.

LocalizeStrFieldsGet

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

<QUERY>
<MC_QUERY_NAME>LocalizeStrFieldsGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeStrFieldsGet</MC_ANSWER_NAME>
<Name>WideString</Name>
<ShowOnInfo>Boolean</ShowOnInfo>
<Result>Integer</Result>
</ANSWER>

Name

Field name.

ShowOnInfo

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

Result

Returns value from error code table.

LocalizeStrFieldsSet

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

<QUERY>
<MC_QUERY_NAME>LocalizeStrFieldsSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
<Name>WideString</Name>
<ShowOnInfo>Boolean</ShowOnInfo>
</QUERY>

SessionID

Session identifier.

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.

Name

Field name.

ShowOnInfo

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


<ANSWER>
<MC_ANSWER_NAME>LocalizeStrFieldsSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeStrFieldsAdd

Adds a new field to the string fields collection saved in the server session. The field is appended at the end of the collection.

<QUERY>
<MC_QUERY_NAME>LocalizeStrFieldsAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Name>WideString</Name>
<ShowOnInfo>Boolean</ShowOnInfo>
</QUERY>

SessionID

Session identifier.

Name

Field name.

ShowOnInfo

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


<ANSWER>
<MC_ANSWER_NAME>LocalizeStrFieldsAdd</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeStrFieldsRemove

Removes a field from the string fields collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeStrFieldsRemove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeStrFieldsRemove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeStrFieldsClear

Removes all fields from the string fields collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeStrFieldsClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeStrFieldsClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeStrFieldsGetCount

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

<QUERY>
<MC_QUERY_NAME>LocalizeStrFieldsGetCount</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeStrFieldsGetCount</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

The number of fields in a collection.

Result

Returns value from error code table.

LocalizeIconAdd

Adds a new icon to the icons collection saved in the server session. The icon is appended at the end of the collection.

<QUERY>
<MC_QUERY_NAME>LocalizeIconAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<IconInfo>
<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>
</IconInfo>
<IconData>BLOB</IconData>
</QUERY>

SessionID

Session identifier.

IconInfo TIconProperties

Icon properties.

IconData

An icon transferred as a byte stream.


<ANSWER>
<MC_ANSWER_NAME>LocalizeIconAdd</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeIconGet

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

<QUERY>
<MC_QUERY_NAME>LocalizeIconGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ItemIndex>Integer</ItemIndex>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeIconGet</MC_ANSWER_NAME>
<IconInfo>
<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>
</IconInfo>
<IconData>BLOB</IconData>
<Result>Integer</Result>
</ANSWER>

IconInfo TIconProperties

Icon properties.

IconData

An icon transferred as a byte stream.

Result

Returns value from error code table.

LocalizeIconSet

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

<QUERY>
<MC_QUERY_NAME>LocalizeIconSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ItemIndex>Integer</ItemIndex>
<IconInfo>
<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>
</IconInfo>
<IconData>BLOB</IconData>
</QUERY>

SessionID

Session identifier.

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.

IconInfo TIconProperties

Icon properties.

IconData

An icon transferred as a byte stream.


<ANSWER>
<MC_ANSWER_NAME>LocalizeIconSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeIconGetCount

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

<QUERY>
<MC_QUERY_NAME>LocalizeIconGetCount</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeIconGetCount</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

The number of icons in a collection.

Result

Returns value from error code table.

LocalizeIconRemove

Removes an icon from the icons collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeIconRemove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ItemIndex>Integer</ItemIndex>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeIconRemove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeIconClear

Removes all icons from the icons collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeIconClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeIconClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeIconIDToItemIndex

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

<QUERY>
<MC_QUERY_NAME>LocalizeIconIDToItemIndex</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<IconId>Integer</IconId>
</QUERY>

SessionID

Session identifier.

IconId

A unique icon identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeIconIDToItemIndex</MC_ANSWER_NAME>
<ItemIndex>Integer</ItemIndex>
<Result>Integer</Result>
</ANSWER>

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.

Result

Returns value from error code table.

LocalizeObjectPositionAdd

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.

<QUERY>
<MC_QUERY_NAME>LocalizeObjectPositionAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
<NumFields>
<ITEM>Double</ITEM>
</NumFields>
<StrFields>
<ITEM>WideString</ITEM>
</StrFields>
<PositionPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</PositionPoint>
<Time>Double</Time>
<Description>WideString</Description>
<ShowDescription>Boolean</ShowDescription>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<FontParams>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</FontParams>
</QUERY>

SessionID

Session identifier.

EntityID

The unique localized object identifier.

NumFields TFloatArray

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

StrFields TWideStringArray

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

PositionPoint TLongLatPoint

Geographic coordinates of the position point.

Time

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

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.

ShowDescription

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

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).

IconID

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

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).

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).

FontParams TFontParameters

A font of position description displayed on maps.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectPositionAdd</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeObjectPositionGet

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

<QUERY>
<MC_QUERY_NAME>LocalizeObjectPositionGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
<ItemIndex>Integer</ItemIndex>
</QUERY>

SessionID

Session identifier.

EntityID

The unique localized object identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectPositionGet</MC_ANSWER_NAME>
<NumFields>
<ITEM>Double</ITEM>
</NumFields>
<StrFields>
<ITEM>WideString</ITEM>
</StrFields>
<PositionPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</PositionPoint>
<Time>Double</Time>
<Description>WideString</Description>
<ShowDescription>Boolean</ShowDescription>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<FontParams>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</FontParams>
<Result>Integer</Result>
</ANSWER>

NumFields TFloatArray

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

StrFields TWideStringArray

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

PositionPoint TLongLatPoint

Geographic coordinates of the position point.

Time

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

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.

ShowDescription

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

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).

IconID

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

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).

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).

FontParams TFontParameters

A font of position description displayed on maps.

Result

Returns value from error code table.

LocalizeObjectPositionSet

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

<QUERY>
<MC_QUERY_NAME>LocalizeObjectPositionSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
<ItemIndex>Integer</ItemIndex>
<NumFields>
<ITEM>Double</ITEM>
</NumFields>
<StrFields>
<ITEM>WideString</ITEM>
</StrFields>
<PositionPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</PositionPoint>
<Time>Double</Time>
<Description>WideString</Description>
<ShowDescription>Boolean</ShowDescription>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<FontParams>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</FontParams>
</QUERY>

SessionID

Session identifier.

EntityID

The unique localized object identifier.

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.

NumFields TFloatArray

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

StrFields TWideStringArray

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

PositionPoint TLongLatPoint

Geographic coordinates of the position point.

Time

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

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.

ShowDescription

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

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).

IconID

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

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).

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).

FontParams TFontParameters

A font of position description displayed on maps.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectPositionSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeObjectPositionRemove

Removes an object position from the positions collection of the given localized object saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeObjectPositionRemove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
<ItemIndex>Integer</ItemIndex>
</QUERY>

SessionID

Session identifier.

EntityID

The unique localized object identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectPositionRemove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeObjectPositionClear

Removes all object positions from the positions collection of the given localized object saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeObjectPositionClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
</QUERY>

SessionID

Session identifier.

EntityID

The unique localized object identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectPositionClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeObjectPositionGetCount

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

<QUERY>
<MC_QUERY_NAME>LocalizeObjectPositionGetCount</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
</QUERY>

SessionID

Session identifier.

EntityID

The unique localized object identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectPositionGetCount</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

The number of object positions of the localized object.

Result

Returns value from error code table.

LocalizeObjectAdd

Adds a new object to the localized objects collection saved in the server session. The object is appended at the end of the collection.

<QUERY>
<MC_QUERY_NAME>LocalizeObjectAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
<Name>WideString</Name>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<PathColor>Integer</PathColor>
<PathWidth>Integer</PathWidth>
<Size>Integer</Size>
<RemovePreviousPositions>Boolean</RemovePreviousPositions>
<PointsConnected>Boolean</PointsConnected>
<ShowDirection>Boolean</ShowDirection>
<FontParams>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</FontParams>
</QUERY>

SessionID

Session identifier.

EntityID

The unique object identifier.

Name

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

ShowName

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

IconID

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

ShowIcon

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

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).

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).

PathWidth

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

Size

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

RemovePreviousPositions

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

PointsConnected

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

ShowDirection

Information on whether to display direction arrows on track lines.

FontParams TFontParameters

A font of object name displayed on maps.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectAdd</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeObjectGet

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

<QUERY>
<MC_QUERY_NAME>LocalizeObjectGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ItemIndex>Integer</ItemIndex>
<ShowDirection>Boolean</ShowDirection>
</QUERY>

SessionID

Session identifier.

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.

ShowDirection

Information on whether to display direction arrows on track lines.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectGet</MC_ANSWER_NAME>
<EntityID>Integer</EntityID>
<Name>WideString</Name>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<PathColor>Integer</PathColor>
<PathWidth>Integer</PathWidth>
<Size>Integer</Size>
<RemovePreviousPositions>Boolean</RemovePreviousPositions>
<PointsConnected>Boolean</PointsConnected>
<FontParams>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</FontParams>
<Result>Integer</Result>
</ANSWER>

EntityID

The unique object identifier.

Name

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

ShowName

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

IconID

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

ShowIcon

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

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).

PathColor

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

PathWidth

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

Size

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

RemovePreviousPositions

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

PointsConnected

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

FontParams TFontParameters

A font of object name displayed on maps.

Result

Returns value from error code table.

LocalizeObjectSet

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

<QUERY>
<MC_QUERY_NAME>LocalizeObjectSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ItemIndex>Integer</ItemIndex>
<EntityID>Integer</EntityID>
<Name>WideString</Name>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<PathColor>Integer</PathColor>
<PathWidth>Integer</PathWidth>
<Size>Integer</Size>
<RemovePreviousPositions>Boolean</RemovePreviousPositions>
<PointsConnected>Boolean</PointsConnected>
<ShowDirection>Boolean</ShowDirection>
<FontParams>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</FontParams>
</QUERY>

SessionID

Session identifier.

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.

EntityID

The unique object identifier.

Name

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

ShowName

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

IconID

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

ShowIcon

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

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).

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).

PathWidth

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

Size

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

RemovePreviousPositions

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

PointsConnected

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

ShowDirection

Information on whether to display direction arrows on track lines.

FontParams TFontParameters

A font of object name displayed on maps.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeObjectRemove

Removes an object from the localized objects collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeObjectRemove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ItemIndex>Integer</ItemIndex>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectRemove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeObjectClear

Removes all objects from the localized objects collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeObjectClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeObjectGetCount

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

<QUERY>
<MC_QUERY_NAME>LocalizeObjectGetCount</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectGetCount</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

The number of objects in a collection.

Result

Returns value from error code table.

LocalizeObjectEntityIDToItemIndex

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

<QUERY>
<MC_QUERY_NAME>LocalizeObjectEntityIDToItemIndex</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
</QUERY>

SessionID

Session identifier.

EntityID

The unique object identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectEntityIDToItemIndex</MC_ANSWER_NAME>
<ItemIndex>Integer</ItemIndex>
<Result>Integer</Result>
</ANSWER>

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.

Result

Returns value from error code table.

LocalizeObjectAddWithPositions

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.

<QUERY>
<MC_QUERY_NAME>LocalizeObjectAddWithPositions</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
<Name>WideString</Name>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<PathColor>Integer</PathColor>
<PathWidth>Integer</PathWidth>
<Size>Integer</Size>
<RemovePreviousPositions>Boolean</RemovePreviousPositions>
<PointsConnected>Boolean</PointsConnected>
<ShowDirection>Boolean</ShowDirection>
<FontParams>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</FontParams>
<ObjectPositions>
<ITEM>
<PositionPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</PositionPoint>
<Time>Double</Time>
<Description>WideString</Description>
<ShowDescription>Boolean</ShowDescription>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<Font>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</Font>
</ITEM>
</ObjectPositions>
<StringFields>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</StringFields>
<FloatFields>
<ITEM>
<ITEM>Double</ITEM>
</ITEM>
</FloatFields>
</QUERY>

SessionID

Session identifier.

EntityID

The unique object identifier.

Name

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

ShowName

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

IconID

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

ShowIcon

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

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).

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).

PathWidth

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

Size

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

RemovePreviousPositions

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

PointsConnected

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

ShowDirection

Information on whether to display direction arrows on track lines.

FontParams TFontParameters

A font of object name displayed on maps.

ObjectPositions TLocalizeObjectPositionDataArray

A list of positions of the object.

StringFields TWideStringArrayArray

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

FloatFields TFloatArrayArray

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


<ANSWER>
<MC_ANSWER_NAME>LocalizeObjectAddWithPositions</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeAddObjectPositions

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.

<QUERY>
<MC_QUERY_NAME>LocalizeAddObjectPositions</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntityID>Integer</EntityID>
<ObjectPositions>
<ITEM>
<PositionPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</PositionPoint>
<Time>Double</Time>
<Description>WideString</Description>
<ShowDescription>Boolean</ShowDescription>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<Font>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</Font>
</ITEM>
</ObjectPositions>
<StringFields>
<ITEM>
<ITEM>WideString</ITEM>
</ITEM>
</StringFields>
<FloatFields>
<ITEM>
<ITEM>Double</ITEM>
</ITEM>
</FloatFields>
</QUERY>

SessionID

Session identifier.

EntityID

The unique localized object identifier.

ObjectPositions TLocalizeObjectPositionDataArray

A list of positions of the object.

StringFields TWideStringArrayArray

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

FloatFields TFloatArrayArray

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


<ANSWER>
<MC_ANSWER_NAME>LocalizeAddObjectPositions</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeSetObjectVisibility

Changes the visibility of all localized object in collection saved in the server session.

<QUERY>
<MC_QUERY_NAME>LocalizeSetObjectVisibility</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ObjectVisibility>
<ITEM>Boolean</ITEM>
</ObjectVisibility>
</QUERY>

SessionID

Session identifier.

ObjectVisibility TBooleanArray

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


<ANSWER>
<MC_ANSWER_NAME>LocalizeSetObjectVisibility</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

LocalizeGetObjectVisibility

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

<QUERY>
<MC_QUERY_NAME>LocalizeGetObjectVisibility</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>LocalizeGetObjectVisibility</MC_ANSWER_NAME>
<ObjectVisibility>
<ITEM>Boolean</ITEM>
</ObjectVisibility>
<Result>Integer</Result>
</ANSWER>

ObjectVisibility TBooleanArray

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

Result

Returns value from error code table.

GetAvailableIconFormats

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

<QUERY>
<MC_QUERY_NAME>GetAvailableIconFormats</MC_QUERY_NAME>
</QUERY>


<ANSWER>
<MC_ANSWER_NAME>GetAvailableIconFormats</MC_ANSWER_NAME>
<IconFormats>
<ITEM>WideString</ITEM>
</IconFormats>
<Result>Integer</Result>
</ANSWER>

IconFormats TWideStringArray

The list of formats.

Result

Returns value from error code table.

RoutePlannerGetAvailableRoadTypes

Returns a list of road types.

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetAvailableRoadTypes</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetAvailableRoadTypes</MC_ANSWER_NAME>
<RoadTypes>
<ITEM>WideString</ITEM>
</RoadTypes>
<Result>Integer</Result>
</ANSWER>

RoadTypes TWideStringArray

The list of road types.

Result

Returns value from error code table.

RoutePlannerSimpleCalculateRoute

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerSimpleCalculateRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<VehicleParams>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
</VehicleParams>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<RouteCalculateType>Integer</RouteCalculateType>
<CalculateRoute>Boolean</CalculateRoute>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<StoreDriverParamsInSession>Boolean</StoreDriverParamsInSession>
<StoreVehicleParamsInSession>Boolean</StoreVehicleParamsInSession>
<StoreRoadParamsInSession>Boolean</StoreRoadParamsInSession>
<StoreRoutePlanEntriesInSession>Boolean</StoreRoutePlanEntriesInSession>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

VehicleParams TVehicleParams

Vehicle parameters.

DriverParams TDriverParams

Driver parameters.

RoadParams TRoadParamsArray

Road parameters.

RouteCalculateType

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

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.

ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

StoreDriverParamsInSession

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

StoreVehicleParamsInSession

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

StoreRoadParamsInSession

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

StoreRoutePlanEntriesInSession

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerSimpleCalculateRoute</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerSimpleCalculateRoute2

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerSimpleCalculateRoute2</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<VehicleParams>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</VehicleParams>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<ViaTollParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollParams>
<RouteCalculateType>Integer</RouteCalculateType>
<CalculateRoute>Boolean</CalculateRoute>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<ReturnViaTollRoadResults>Boolean</ReturnViaTollRoadResults>
<StoreDriverParamsInSession>Boolean</StoreDriverParamsInSession>
<StoreVehicleParamsInSession>Boolean</StoreVehicleParamsInSession>
<StoreRoadParamsInSession>Boolean</StoreRoadParamsInSession>
<StoreRoutePlanEntriesInSession>Boolean</StoreRoutePlanEntriesInSession>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

VehicleParams TVehicleEntry

Vehicle parameters.

DriverParams TDriverParams

Driver parameters.

RoadParams TRoadParamsArray

Road parameters.

ViaTollParams TRoadViaTollParamsArray

viaTOLL parameters.

RouteCalculateType

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

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.

ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

ReturnViaTollRoadResults

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

StoreDriverParamsInSession

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

StoreVehicleParamsInSession

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

StoreRoadParamsInSession

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

StoreRoutePlanEntriesInSession

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerSimpleCalculateRoute2</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<TotalViaTollLength>Double</TotalViaTollLength>
<TotalViaTollCost>Double</TotalViaTollCost>
<TotalChargeRoadLength>Double</TotalChargeRoadLength>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<ViaTollRoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollLength>Double</ViaTollLength>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollRoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

TotalViaTollLength

Total viaTOLL segments' length in meters.

TotalViaTollCost

Total viaTOLL cost.

TotalChargeRoadLength

Total length of charged segments (in meters).

RoadResults TRoadResultsArray

Route results divided into separated road types.

ViaTollRoadResults TViaTollRoadResultsArray

viaTOLL results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerSimpleCalculateRoute3

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerSimpleCalculateRoute3</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<VehicleParams>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</VehicleParams>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<ViaTollParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollParams>
<RoutePlannerParams>
<ITEM>WideString</ITEM>
</RoutePlannerParams>
<SubscribeProviders>
<ITEM>WideString</ITEM>
</SubscribeProviders>
<DriveThroughEntries>
<ITEM>
<EntryIndex>Integer</EntryIndex>
<SetAsDriveThrough>Boolean</SetAsDriveThrough>
<Radius>Double</Radius>
</ITEM>
</DriveThroughEntries>
<RouteCalculateType>Integer</RouteCalculateType>
<CalculateRoute>Boolean</CalculateRoute>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<ReturnViaTollRoadResults>Boolean</ReturnViaTollRoadResults>
<ReturnLogisticTOLLResults>Boolean</ReturnLogisticTOLLResults>
<StoreDriverParamsInSession>Boolean</StoreDriverParamsInSession>
<StoreVehicleParamsInSession>Boolean</StoreVehicleParamsInSession>
<StoreRoadParamsInSession>Boolean</StoreRoadParamsInSession>
<StoreRoutePlanEntriesInSession>Boolean</StoreRoutePlanEntriesInSession>
<StoreRoutePlannerParamsInSession>Boolean</StoreRoutePlannerParamsInSession>
<StoreSubscribeProvidersInSession>Boolean</StoreSubscribeProvidersInSession>
<StoreDriveThroughEntriesInSession>Boolean</StoreDriveThroughEntriesInSession>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

VehicleParams TVehicleEntry

Vehicle parameters.

DriverParams TDriverParams

Driver parameters.

RoadParams TRoadParamsArray

Road parameters.

ViaTollParams TRoadViaTollParamsArray

viaTOLL parameters.

RoutePlannerParams TWideStringArray

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.

SubscribeProviders TWideStringArray

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

DriveThroughEntries TDriveThroughArray

Waypoint settings as precise points or with tollerance.

RouteCalculateType

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

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.

ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

ReturnViaTollRoadResults

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

ReturnLogisticTOLLResults

Option of returning toll road costs divided into separated countries.

StoreDriverParamsInSession

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

StoreVehicleParamsInSession

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

StoreRoadParamsInSession

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

StoreRoutePlanEntriesInSession

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

StoreRoutePlannerParamsInSession

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

StoreSubscribeProvidersInSession

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

StoreDriveThroughEntriesInSession

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerSimpleCalculateRoute3</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<TotalViaTollLength>Double</TotalViaTollLength>
<TotalViaTollCost>Double</TotalViaTollCost>
<TotalChargeRoadLength>Double</TotalChargeRoadLength>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<ViaTollRoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollLength>Double</ViaTollLength>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollRoadResults>
<LogisticTOLLResults>
<ITEM>
<CountryName>WideString</CountryName>
<EntryType>WideString</EntryType>
<PaymentCurrency>WideString</PaymentCurrency>
<PaymentOriginalCurrency>Double</PaymentOriginalCurrency>
<PaymentLocalCurrency>Double</PaymentLocalCurrency>
<VAT>Double</VAT>
</ITEM>
</LogisticTOLLResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

TotalViaTollLength

Total viaTOLL segments' length in meters.

TotalViaTollCost

Total viaTOLL cost.

TotalChargeRoadLength

Total length of charged segments (in meters).

RoadResults TRoadResultsArray

Route results divided into separated road types.

ViaTollRoadResults TViaTollRoadResultsArray

viaTOLL results divided into separated road types.

LogisticTOLLResults TLogisticTOLLResultsArray

Toll costs divided into separated countries.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerSimpleCalculateAlternativeRoutesAndStore

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerSimpleCalculateAlternativeRoutesAndStore</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<VehicleParams>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</VehicleParams>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<ViaTollParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollParams>
<RoutePlannerParams>
<ITEM>WideString</ITEM>
</RoutePlannerParams>
<SubscribeProviders>
<ITEM>WideString</ITEM>
</SubscribeProviders>
<DriveThroughEntries>
<ITEM>
<EntryIndex>Integer</EntryIndex>
<SetAsDriveThrough>Boolean</SetAsDriveThrough>
<Radius>Double</Radius>
</ITEM>
</DriveThroughEntries>
<RouteCalculateType>Integer</RouteCalculateType>
<StoreFirstRouteInSession>Boolean</StoreFirstRouteInSession>
<StoreInRepository>Boolean</StoreInRepository>
<ReplaceRepository>Boolean</ReplaceRepository>
<UseIdentsArray>Boolean</UseIdentsArray>
<IdentsArray>
<ITEM>Integer</ITEM>
</IdentsArray>
<UseColorArray>Boolean</UseColorArray>
<ColorArray>
<ITEM>Integer</ITEM>
</ColorArray>
<StoreDriverParamsInSession>Boolean</StoreDriverParamsInSession>
<StoreVehicleParamsInSession>Boolean</StoreVehicleParamsInSession>
<StoreRoadParamsInSession>Boolean</StoreRoadParamsInSession>
<StoreRoutePlanEntriesInSession>Boolean</StoreRoutePlanEntriesInSession>
<StoreRoutePlannerParamsInSession>Boolean</StoreRoutePlannerParamsInSession>
<StoreSubscribeProvidersInSession>Boolean</StoreSubscribeProvidersInSession>
<StoreDriveThroughEntriesInSession>Boolean</StoreDriveThroughEntriesInSession>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

VehicleParams TVehicleEntry

Vehicle parameters.

DriverParams TDriverParams

Driver parameters.

RoadParams TRoadParamsArray

Road parameters.

ViaTollParams TRoadViaTollParamsArray

viaTOLL parameters.

RoutePlannerParams TWideStringArray

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.

SubscribeProviders TWideStringArray

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

DriveThroughEntries TDriveThroughArray

Waypoint settings as precise points or with tollerance.

RouteCalculateType

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

StoreFirstRouteInSession

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

StoreInRepository

Option of storing routes in the repository.

ReplaceRepository

Option of replacing old routes in the repository.

UseIdentsArray

Option of storing routes assigned with identifiers.

IdentsArray TDynamicIntegerArray

A list of identifiers for routes to be stored.

UseColorArray

Option of storing routes assigned with colors.

ColorArray TDynamicIntegerArray

A list of colors for routes to be stored.

StoreDriverParamsInSession

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

StoreVehicleParamsInSession

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

StoreRoadParamsInSession

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

StoreRoutePlanEntriesInSession

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

StoreRoutePlannerParamsInSession

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

StoreSubscribeProvidersInSession

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

StoreDriveThroughEntriesInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerSimpleCalculateAlternativeRoutesAndStore</MC_ANSWER_NAME>
<ResultCount>Integer</ResultCount>
<TotalRouteLengths>
<ITEM>Double</ITEM>
</TotalRouteLengths>
<TotalRouteTimes>
<ITEM>Double</ITEM>
</TotalRouteTimes>
<TotalRouteCosts>
<ITEM>Double</ITEM>
</TotalRouteCosts>
<BoundingRect>
<ITEM>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</ITEM>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

ResultCount

Number of resultant routes.

TotalRouteLengths TFloatArray

Total length in meters for each calculated route.

TotalRouteTimes TFloatArray

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCosts TFloatArray

Total cost for each calculated route.

BoundingRect TLongLatRectArray

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerCalculateAlternativeRoutesAndStore

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateAlternativeRoutesAndStore</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RouteCalculateType>Integer</RouteCalculateType>
<StoreFirstRouteInSession>Boolean</StoreFirstRouteInSession>
<StoreInRepository>Boolean</StoreInRepository>
<ReplaceRepository>Boolean</ReplaceRepository>
<UseIdentsArray>Boolean</UseIdentsArray>
<IdentsArray>
<ITEM>Integer</ITEM>
</IdentsArray>
<UseColorArray>Boolean</UseColorArray>
<ColorArray>
<ITEM>Integer</ITEM>
</ColorArray>
</QUERY>

SessionID

Session identifier.

RouteCalculateType

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

StoreFirstRouteInSession

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

StoreInRepository

Option of storing routes in the repository.

ReplaceRepository

Option of replacing old routes in the repository.

UseIdentsArray

Option of storing routes assigned with identifiers.

IdentsArray TDynamicIntegerArray

A list of identifiers for routes to be stored.

UseColorArray

Option of storing routes assigned with colors.

ColorArray TDynamicIntegerArray

A list of colors for routes to be stored.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateAlternativeRoutesAndStore</MC_ANSWER_NAME>
<ResultCount>Integer</ResultCount>
<TotalRouteLengths>
<ITEM>Double</ITEM>
</TotalRouteLengths>
<TotalRouteTimes>
<ITEM>Double</ITEM>
</TotalRouteTimes>
<TotalRouteCosts>
<ITEM>Double</ITEM>
</TotalRouteCosts>
<BoundingRect>
<ITEM>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</ITEM>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

ResultCount

Number of resultant routes.

TotalRouteLengths TFloatArray

Total length in meters for each calculated route.

TotalRouteTimes TFloatArray

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCosts TFloatArray

Total cost for each calculated route.

BoundingRect TLongLatRectArray

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerSimpleCalculateRouteWithBinaryResult

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).

<QUERY>
<MC_QUERY_NAME>RoutePlannerSimpleCalculateRouteWithBinaryResult</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<VehicleParams>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
</VehicleParams>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<RouteCalculateType>Integer</RouteCalculateType>
<CalculateRoute>Boolean</CalculateRoute>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<StoreDriverParamsInSession>Boolean</StoreDriverParamsInSession>
<StoreVehicleParamsInSession>Boolean</StoreVehicleParamsInSession>
<StoreRoadParamsInSession>Boolean</StoreRoadParamsInSession>
<StoreRoutePlanEntriesInSession>Boolean</StoreRoutePlanEntriesInSession>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

VehicleParams TVehicleParams

Vehicle parameters.

DriverParams TDriverParams

Driver parameters.

RoadParams TRoadParamsArray

Road parameters.

RouteCalculateType

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

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.

ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

StoreDriverParamsInSession

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

StoreVehicleParamsInSession

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

StoreRoadParamsInSession

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

StoreRoutePlanEntriesInSession

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerSimpleCalculateRouteWithBinaryResult</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BinaryRouteRepresentation>BLOB</BinaryRouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

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.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerSimpleCalculateRoute2WithBinaryResult

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).

<QUERY>
<MC_QUERY_NAME>RoutePlannerSimpleCalculateRoute2WithBinaryResult</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<VehicleParams>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</VehicleParams>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<ViaTollParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollParams>
<RouteCalculateType>Integer</RouteCalculateType>
<CalculateRoute>Boolean</CalculateRoute>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<ReturnViaTollRoadResults>Boolean</ReturnViaTollRoadResults>
<StoreDriverParamsInSession>Boolean</StoreDriverParamsInSession>
<StoreVehicleParamsInSession>Boolean</StoreVehicleParamsInSession>
<StoreRoadParamsInSession>Boolean</StoreRoadParamsInSession>
<StoreRoutePlanEntriesInSession>Boolean</StoreRoutePlanEntriesInSession>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

VehicleParams TVehicleEntry

Vehicle parameters.

DriverParams TDriverParams

Driver parameters.

RoadParams TRoadParamsArray

Road parameters.

ViaTollParams TRoadViaTollParamsArray

viaTOLL parameters.

RouteCalculateType

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

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.

ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

ReturnViaTollRoadResults

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

StoreDriverParamsInSession

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

StoreVehicleParamsInSession

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

StoreRoadParamsInSession

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

StoreRoutePlanEntriesInSession

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerSimpleCalculateRoute2WithBinaryResult</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<TotalViaTollLength>Double</TotalViaTollLength>
<TotalViaTollCost>Double</TotalViaTollCost>
<TotalChargeRoadLength>Double</TotalChargeRoadLength>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<ViaTollRoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollLength>Double</ViaTollLength>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollRoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BinaryRouteRepresentation>BLOB</BinaryRouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

TotalViaTollLength

Total viaTOLL segments' length in meters.

TotalViaTollCost

Total viaTOLL cost.

TotalChargeRoadLength

Total length of charged segments (in meters).

RoadResults TRoadResultsArray

Route results divided into separated road types.

ViaTollRoadResults TViaTollRoadResultsArray

viaTOLL results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

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.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerSimpleCalculateRoute3WithBinaryResult

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).

<QUERY>
<MC_QUERY_NAME>RoutePlannerSimpleCalculateRoute3WithBinaryResult</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<VehicleParams>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</VehicleParams>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<ViaTollParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollParams>
<RoutePlannerParams>
<ITEM>WideString</ITEM>
</RoutePlannerParams>
<SubscribeProviders>
<ITEM>WideString</ITEM>
</SubscribeProviders>
<DriveThroughEntries>
<ITEM>
<EntryIndex>Integer</EntryIndex>
<SetAsDriveThrough>Boolean</SetAsDriveThrough>
<Radius>Double</Radius>
</ITEM>
</DriveThroughEntries>
<RouteCalculateType>Integer</RouteCalculateType>
<CalculateRoute>Boolean</CalculateRoute>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<ReturnViaTollRoadResults>Boolean</ReturnViaTollRoadResults>
<ReturnLogisticTOLLResults>Boolean</ReturnLogisticTOLLResults>
<StoreDriverParamsInSession>Boolean</StoreDriverParamsInSession>
<StoreVehicleParamsInSession>Boolean</StoreVehicleParamsInSession>
<StoreRoadParamsInSession>Boolean</StoreRoadParamsInSession>
<StoreRoutePlanEntriesInSession>Boolean</StoreRoutePlanEntriesInSession>
<StoreRoutePlannerParamsInSession>Boolean</StoreRoutePlannerParamsInSession>
<StoreSubscribeProvidersInSession>Boolean</StoreSubscribeProvidersInSession>
<StoreDriveThroughEntriesInSession>Boolean</StoreDriveThroughEntriesInSession>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

VehicleParams TVehicleEntry

Vehicle parameters.

DriverParams TDriverParams

Driver parameters.

RoadParams TRoadParamsArray

Road parameters.

ViaTollParams TRoadViaTollParamsArray

viaTOLL parameters.

RoutePlannerParams TWideStringArray

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.

SubscribeProviders TWideStringArray

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

DriveThroughEntries TDriveThroughArray

Waypoint settings as precise points or with tollerance.

RouteCalculateType

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

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.

ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

ReturnViaTollRoadResults

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

ReturnLogisticTOLLResults

Option of returning toll road costs divided into separated countries.

StoreDriverParamsInSession

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

StoreVehicleParamsInSession

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

StoreRoadParamsInSession

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

StoreRoutePlanEntriesInSession

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

StoreRoutePlannerParamsInSession

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

StoreSubscribeProvidersInSession

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

StoreDriveThroughEntriesInSession

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerSimpleCalculateRoute3WithBinaryResult</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<TotalViaTollLength>Double</TotalViaTollLength>
<TotalViaTollCost>Double</TotalViaTollCost>
<TotalChargeRoadLength>Double</TotalChargeRoadLength>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<ViaTollRoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollLength>Double</ViaTollLength>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollRoadResults>
<LogisticTOLLResults>
<ITEM>
<CountryName>WideString</CountryName>
<EntryType>WideString</EntryType>
<PaymentCurrency>WideString</PaymentCurrency>
<PaymentOriginalCurrency>Double</PaymentOriginalCurrency>
<PaymentLocalCurrency>Double</PaymentLocalCurrency>
<VAT>Double</VAT>
</ITEM>
</LogisticTOLLResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BinaryRouteRepresentation>BLOB</BinaryRouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

TotalViaTollLength

Total viaTOLL segments' length in meters.

TotalViaTollCost

Total viaTOLL cost.

TotalChargeRoadLength

Total length of charged segments (in meters).

RoadResults TRoadResultsArray

Route results divided into separated road types.

ViaTollRoadResults TViaTollRoadResultsArray

viaTOLL results divided into separated road types.

LogisticTOLLResults TLogisticTOLLResultsArray

Toll costs divided into separated countries.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

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.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerCalculateRoute

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RouteCalculateType>Integer</RouteCalculateType>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RouteCalculateType

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

ReturnRoutePlanEntriesDescription

Option of returning user or automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateRoute</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

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.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerCalculateRouteWithBinaryResult

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).

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateRouteWithBinaryResult</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RouteCalculateType>Integer</RouteCalculateType>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RouteCalculateType

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

ReturnRoutePlanEntriesDescription

Option of returning user or automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateRouteWithBinaryResult</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BinaryRouteRepresentation>BLOB</BinaryRouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

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.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

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.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RoutePlannerGetRouteItinerary

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetRouteItinerary</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetRouteItinerary</MC_ANSWER_NAME>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<Result>Integer</Result>
</ANSWER>

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events.

Result

Returns value from error code table.

RoutePlannerGetRouteRepresentation

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetRouteRepresentation</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetRouteRepresentation</MC_ANSWER_NAME>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<Result>Integer</Result>
</ANSWER>

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route.

Result

Returns value from error code table.

RoutePlannerGetRouteRepresentationWithBinaryResult

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetRouteRepresentationWithBinaryResult</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetRouteRepresentationWithBinaryResult</MC_ANSWER_NAME>
<BinaryRouteRepresentation>BLOB</BinaryRouteRepresentation>
<Result>Integer</Result>
</ANSWER>

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).

Result

Returns value from error code table.

RoutePlannerGetRouteSummary

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetRouteSummary</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ReturnRoadResults>Boolean</ReturnRoadResults>
</QUERY>

SessionID

Session identifier.

ReturnRoadResults

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetRouteSummary</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<RouteCalculateType>Integer</RouteCalculateType>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost without viaTOLL costs.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

RouteCalculateType

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

Result

Returns value from error code table.

RoutePlannerGetRouteViaTollSummary

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetRouteViaTollSummary</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetRouteViaTollSummary</MC_ANSWER_NAME>
<ViaTollRoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollLength>Double</ViaTollLength>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollRoadResults>
<Result>Integer</Result>
</ANSWER>

ViaTollRoadResults TViaTollRoadResultsArray

viaTOLL results divided into separated road types.

Result

Returns value from error code table.

RoutePlannerGetRouteLogisticTOLLSummary

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetRouteLogisticTOLLSummary</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetRouteLogisticTOLLSummary</MC_ANSWER_NAME>
<LogisticTOLLRoadResults>
<ITEM>
<CountryName>WideString</CountryName>
<EntryType>WideString</EntryType>
<PaymentCurrency>WideString</PaymentCurrency>
<PaymentOriginalCurrency>Double</PaymentOriginalCurrency>
<PaymentLocalCurrency>Double</PaymentLocalCurrency>
<VAT>Double</VAT>
</ITEM>
</LogisticTOLLRoadResults>
<Result>Integer</Result>
</ANSWER>

LogisticTOLLRoadResults TLogisticTOLLResultsArray

Toll costs divided into separated countries.

Result

Returns value from error code table.

RoutePlannerEntriesSet

Sets waypoint list in the session replacing present list.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<RoutePlanVisitTimes>
<ITEM>Double</ITEM>
</RoutePlanVisitTimes>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

RoutePlanVisitTimes TFloatArray

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesSet</MC_ANSWER_NAME>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<Result>Integer</Result>
</ANSWER>

RoutePlanEntriesDescription TWideStringArray

Automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road.

Result

Returns value from error code table.

RoutePlannerEntriesSetWithDescription

Sets waypoint list in the session replacing present list. User description for each waypoint can be set.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesSetWithDescription</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<RoutePlanVisitTimes>
<ITEM>Double</ITEM>
</RoutePlanVisitTimes>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

RoutePlanVisitTimes TFloatArray

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

RoutePlanEntriesDescription TWideStringArray

Waypoint descriptions.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesSetWithDescription</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntriesGet

Returns waypoint list stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesGet</MC_ANSWER_NAME>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<RoutePlanVisitTimes>
<ITEM>Double</ITEM>
</RoutePlanVisitTimes>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<Result>Integer</Result>
</ANSWER>

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

RoutePlanVisitTimes TFloatArray

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

RoutePlanEntriesDescription TWideStringArray

Waypoint descriptions.

Result

Returns value from error code table.

RoutePlannerEntriesGetWithSnapPoints

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesGetWithSnapPoints</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesGetWithSnapPoints</MC_ANSWER_NAME>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<RoutePlanEntriesSnapPoints>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntriesSnapPoints>
<RoutePlanVisitTimes>
<ITEM>Double</ITEM>
</RoutePlanVisitTimes>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<Result>Integer</Result>
</ANSWER>

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

RoutePlanEntriesSnapPoints TLongLatPointArray

A list of geographic coordinates of waypoint's snap points.

RoutePlanVisitTimes TFloatArray

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

RoutePlanEntriesDescription TWideStringArray

Waypoint descriptions.

Result

Returns value from error code table.

RoutePlannerEntryAdd

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RoutePlanEntry>
<RoutePlanVisitTime>Double</RoutePlanVisitTime>
</QUERY>

SessionID

Session identifier.

RoutePlanEntry TLongLatPoint

Geographic waypoint coordinates.

RoutePlanVisitTime

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryAdd</MC_ANSWER_NAME>
<RoutePlanEntryDescription>WideString</RoutePlanEntryDescription>
<Result>Integer</Result>
</ANSWER>

RoutePlanEntryDescription

Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.

Result

Returns value from error code table.

RoutePlannerEntryAddWithDescription

Appends a new waypoint with user description to a waypoint list stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryAddWithDescription</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RoutePlanEntry>
<RoutePlanVisitTime>Double</RoutePlanVisitTime>
<RoutePlanEntryDescription>WideString</RoutePlanEntryDescription>
</QUERY>

SessionID

Session identifier.

RoutePlanEntry TLongLatPoint

Geographic waypoint coordinates.

RoutePlanVisitTime

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

RoutePlanEntryDescription

Waypoint description.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryAddWithDescription</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntriesAdd

Adds new waypoints to waypoint list in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<RoutePlanVisitTimes>
<ITEM>Double</ITEM>
</RoutePlanVisitTimes>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

RoutePlanVisitTimes TFloatArray

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesAdd</MC_ANSWER_NAME>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<Result>Integer</Result>
</ANSWER>

RoutePlanEntriesDescription TWideStringArray

Automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road.

Result

Returns value from error code table.

RoutePlannerEntriesAddWithDescription

Adds new waypoints to waypoint list in the session. User description for each waypoint can be set.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesAddWithDescription</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<RoutePlanVisitTimes>
<ITEM>Double</ITEM>
</RoutePlanVisitTimes>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

RoutePlanVisitTimes TFloatArray

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

RoutePlanEntriesDescription TWideStringArray

Waypoint descriptions.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesAddWithDescription</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntryInsert

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryInsert</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<RoutePlanEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RoutePlanEntry>
<RoutePlanVisitTime>Double</RoutePlanVisitTime>
</QUERY>

SessionID

Session identifier.

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.

RoutePlanEntry TLongLatPoint

Geographic waypoint coordinates.

RoutePlanVisitTime

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryInsert</MC_ANSWER_NAME>
<RoutePlanEntryDescription>WideString</RoutePlanEntryDescription>
<Result>Integer</Result>
</ANSWER>

RoutePlanEntryDescription

Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.

Result

Returns value from error code table.

RoutePlannerEntryInsertWithDescription

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryInsertWithDescription</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<RoutePlanEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RoutePlanEntry>
<RoutePlanVisitTime>Double</RoutePlanVisitTime>
<RoutePlanEntryDescription>WideString</RoutePlanEntryDescription>
</QUERY>

SessionID

Session identifier.

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.

RoutePlanEntry TLongLatPoint

Geographic waypoint coordinates.

RoutePlanVisitTime

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

RoutePlanEntryDescription

Waypoint description.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryInsertWithDescription</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntryGet

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryGet</MC_ANSWER_NAME>
<RoutePlanEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RoutePlanEntry>
<RoutePlanVisitTime>Double</RoutePlanVisitTime>
<RoutePlanEntryDescription>WideString</RoutePlanEntryDescription>
<Result>Integer</Result>
</ANSWER>

RoutePlanEntry TLongLatPoint

Geographic waypoint coordinates.

RoutePlanVisitTime

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

RoutePlanEntryDescription

Waypoint description.

Result

Returns value from error code table.

RoutePlannerEntrySet

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntrySet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<RoutePlanEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RoutePlanEntry>
<RoutePlanVisitTime>Double</RoutePlanVisitTime>
</QUERY>

SessionID

Session identifier.

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.

RoutePlanEntry TLongLatPoint

Geographic waypoint coordinates.

RoutePlanVisitTime

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntrySet</MC_ANSWER_NAME>
<RoutePlanEntryDescription>WideString</RoutePlanEntryDescription>
<Result>Integer</Result>
</ANSWER>

RoutePlanEntryDescription

Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.

Result

Returns value from error code table.

RoutePlannerEntrySetWithDescription

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntrySetWithDescription</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<RoutePlanEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</RoutePlanEntry>
<RoutePlanVisitTime>Double</RoutePlanVisitTime>
<RoutePlanEntryDescription>WideString</RoutePlanEntryDescription>
</QUERY>

SessionID

Session identifier.

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.

RoutePlanEntry TLongLatPoint

Geographic waypoint coordinates.

RoutePlanVisitTime

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

RoutePlanEntryDescription

Waypoint description.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntrySetWithDescription</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntryMove

Moves a waypoint from one position in waypoint list stored in the session to another.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryMove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<OldEntryIndex>Integer</OldEntryIndex>
<NewEntryIndex>Integer</NewEntryIndex>
</QUERY>

SessionID

Session identifier.

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.

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.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryMove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntryComplexMove

Moves many waypoints at given positions in waypoint list stored in the session to another positons beginning with one specified position.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryComplexMove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<OldEntryIndexes>
<ITEM>Integer</ITEM>
</OldEntryIndexes>
<NewEntryIndex>Integer</NewEntryIndex>
</QUERY>

SessionID

Session identifier.

OldEntryIndexes TDynamicIntegerArray

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.

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.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryComplexMove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntryReverse

Reverses waypoint list.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryReverse</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryReverse</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntryRemove

Removes waypoint at given position in waypoint list stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntryRemove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

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.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntryRemove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntriesClear

Clears a waypoint list stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerEntriesGetCount

Returns a count of waypoints stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesGetCount</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesGetCount</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

A count of waypoints.

Result

Returns value from error code table.

RoutePlannerEntriesSetAsDriveThrough

Sets waypoints in the session as precise points or with tollerance.

<QUERY>
<MC_QUERY_NAME>RoutePlannerEntriesSetAsDriveThrough</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Entries>
<ITEM>
<EntryIndex>Integer</EntryIndex>
<SetAsDriveThrough>Boolean</SetAsDriveThrough>
<Radius>Double</Radius>
</ITEM>
</Entries>
</QUERY>

SessionID

Session identifier.

Entries TDriveThroughArray

Waypoint properties.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerEntriesSetAsDriveThrough</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerRouteClear

Removes a route last calculated and stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRouteClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRouteClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerCalculateRoutesWithSingleDepot

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateRoutesWithSingleDepot</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DepotEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</DepotEntry>
<DestinationEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</DestinationEntries>
<RouteCalculateType>Integer</RouteCalculateType>
</QUERY>

SessionID

Session identifier.

DepotEntry TLongLatPoint

Geographic coordinates of start point.

DestinationEntries TLongLatPointArray

Geographic coordinates of destination points.

RouteCalculateType

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateRoutesWithSingleDepot</MC_ANSWER_NAME>
<TotalRouteLengths>
<ITEM>Double</ITEM>
</TotalRouteLengths>
<TotalRouteTimes>
<ITEM>Double</ITEM>
</TotalRouteTimes>
<TotalRouteCosts>
<ITEM>Double</ITEM>
</TotalRouteCosts>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLengths TFloatArray

Total length in meters for each calculated route.

TotalRouteTimes TFloatArray

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCosts TFloatArray

Total cost for each calculated route.

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.

Result

Returns value from error code table.

RoutePlannerCalculateRoutesWithSingleDepotAndStore

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateRoutesWithSingleDepotAndStore</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DepotEntry>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</DepotEntry>
<DestinationEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</DestinationEntries>
<RouteCalculateType>Integer</RouteCalculateType>
<StoreInRepository>Boolean</StoreInRepository>
<ReplaceRepository>Boolean</ReplaceRepository>
<UseIdentsArray>Boolean</UseIdentsArray>
<IdentsArray>
<ITEM>Integer</ITEM>
</IdentsArray>
<UseColorArray>Boolean</UseColorArray>
<ColorArray>
<ITEM>Integer</ITEM>
</ColorArray>
</QUERY>

SessionID

Session identifier.

DepotEntry TLongLatPoint

Geographic coordinates of start point.

DestinationEntries TLongLatPointArray

Geographic coordinates of destination points.

RouteCalculateType

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

StoreInRepository

Option of storing routes in the repository.

ReplaceRepository

Option of replacing old routes in the repository.

UseIdentsArray

Option of storing routes assigned with identifiers.

IdentsArray TDynamicIntegerArray

A list of identifiers for routes to be stored.

UseColorArray

Option of storing routes assigned with colors.

ColorArray TDynamicIntegerArray

A list of colors for routes to be stored.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateRoutesWithSingleDepotAndStore</MC_ANSWER_NAME>
<TotalRouteLengths>
<ITEM>Double</ITEM>
</TotalRouteLengths>
<TotalRouteTimes>
<ITEM>Double</ITEM>
</TotalRouteTimes>
<TotalRouteCosts>
<ITEM>Double</ITEM>
</TotalRouteCosts>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLengths TFloatArray

Total length in meters for each calculated route.

TotalRouteTimes TFloatArray

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCosts TFloatArray

Total cost for each calculated route.

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.

Result

Returns value from error code table.

RoutePlannerCalculateRoutesWithMultipleDepots

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateRoutesWithMultipleDepots</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DepotEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</DepotEntries>
<DestinationEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</DestinationEntries>
<RouteCalculateType>Integer</RouteCalculateType>
</QUERY>

SessionID

Session identifier.

DepotEntries TLongLatPointArray

Geographic coordinates of start points.

DestinationEntries TLongLatPointArray

Geographic coordinates of destination points.

RouteCalculateType

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateRoutesWithMultipleDepots</MC_ANSWER_NAME>
<DepotAssigments>
<ITEM>Integer</ITEM>
</DepotAssigments>
<TotalRouteLengths>
<ITEM>Double</ITEM>
</TotalRouteLengths>
<TotalRouteTimes>
<ITEM>Double</ITEM>
</TotalRouteTimes>
<TotalRouteCosts>
<ITEM>Double</ITEM>
</TotalRouteCosts>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

DepotAssigments TDynamicIntegerArray

A list of start point numbers choosen for calculated routes (beginning with 0).

TotalRouteLengths TFloatArray

Total length in meters for each calculated route.

TotalRouteTimes TFloatArray

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCosts TFloatArray

Total cost for each calculated route.

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.

Result

Returns value from error code table.

RoutePlannerCalculateRoutesWithMultipleDepotsAndStore

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateRoutesWithMultipleDepotsAndStore</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DepotEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</DepotEntries>
<DestinationEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</DestinationEntries>
<RouteCalculateType>Integer</RouteCalculateType>
<StoreInRepository>Boolean</StoreInRepository>
<ReplaceRepository>Boolean</ReplaceRepository>
<UseIdentsArray>Boolean</UseIdentsArray>
<IdentsArray>
<ITEM>Integer</ITEM>
</IdentsArray>
<UseColorArray>Boolean</UseColorArray>
<ColorArray>
<ITEM>Integer</ITEM>
</ColorArray>
</QUERY>

SessionID

Session identifier.

DepotEntries TLongLatPointArray

Geographic coordinates of start points.

DestinationEntries TLongLatPointArray

Geographic coordinates of destination points.

RouteCalculateType

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

StoreInRepository

Option of storing routes in the repository.

ReplaceRepository

Option of replacing old routes in the repository.

UseIdentsArray

Option of storing routes assigned with identifiers.

IdentsArray TDynamicIntegerArray

A list of identifiers for routes to be stored.

UseColorArray

Option of storing routes assigned with colors.

ColorArray TDynamicIntegerArray

A list of colors for routes to be stored.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateRoutesWithMultipleDepotsAndStore</MC_ANSWER_NAME>
<DepotAssigments>
<ITEM>Integer</ITEM>
</DepotAssigments>
<TotalRouteLengths>
<ITEM>Double</ITEM>
</TotalRouteLengths>
<TotalRouteTimes>
<ITEM>Double</ITEM>
</TotalRouteTimes>
<TotalRouteCosts>
<ITEM>Double</ITEM>
</TotalRouteCosts>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

DepotAssigments TDynamicIntegerArray

A list of start point numbers choosen for calculated routes (beginning with 0).

TotalRouteLengths TFloatArray

Total length in meters for each calculated route.

TotalRouteTimes TFloatArray

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCosts TFloatArray

Total cost for each calculated route.

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.

Result

Returns value from error code table.

RoutePlannerCalculateRouteDistanceMatrix

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateRouteDistanceMatrix</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<RouteCalculateType>Integer</RouteCalculateType>
<AssumeSymetricDistance>Boolean</AssumeSymetricDistance>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

Geographic coordinates of start (end) points.

RouteCalculateType

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

AssumeSymetricDistance

Option of missing of reverse route calculation.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateRouteDistanceMatrix</MC_ANSWER_NAME>
<TotalRouteLengths>
<ITEM>
<ITEM>Double</ITEM>
</ITEM>
</TotalRouteLengths>
<TotalRouteTimes>
<ITEM>
<ITEM>Double</ITEM>
</ITEM>
</TotalRouteTimes>
<TotalRouteCosts>
<ITEM>
<ITEM>Double</ITEM>
</ITEM>
</TotalRouteCosts>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

TotalRouteLengths TFloatArrayArray

Total length in meters for each calculated route.

TotalRouteTimes TFloatArrayArray

Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCosts TFloatArrayArray

Total cost for each calculated route.

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.

Result

Returns value from error code table.

RoutePlannerCalculatePointDistanceFromRoute

Calculates distances from a route stored in the server session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculatePointDistanceFromRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MaxLength>Double</MaxLength>
<Points>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Points>
</QUERY>

SessionID

Session identifier.

MaxLength

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

Points TLongLatPointArray

A list of points.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculatePointDistanceFromRoute</MC_ANSWER_NAME>
<DistanceFromRoute>
<ITEM>Double</ITEM>
</DistanceFromRoute>
<Result>Integer</Result>
</ANSWER>

DistanceFromRoute TFloatArray

Resultant list of calculated distances (in meters). If calculated distance is greater then MaxLength, it will equal 0.

Result

Returns value from error code table.

RoutePlannerCalculatePointWithinRouteBuffer

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculatePointWithinRouteBuffer</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<BufferRadius>Double</BufferRadius>
<Points>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Points>
</QUERY>

SessionID

Session identifier.

BufferRadius

Buffer radius (in meters).

Points TLongLatPointArray

A list of points.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculatePointWithinRouteBuffer</MC_ANSWER_NAME>
<PointWithinBuffer>
<ITEM>Boolean</ITEM>
</PointWithinBuffer>
<Result>Integer</Result>
</ANSWER>

PointWithinBuffer TBooleanArray

Information on point containment within a buffer.

Result

Returns value from error code table.

RoutePlannerCalculateRouteFromGPSTrack

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.

<QUERY>
<MC_QUERY_NAME>RoutePlannerCalculateRouteFromGPSTrack</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<BinaryFile>BLOB</BinaryFile>
<BinaryFileFormat>Integer</BinaryFileFormat>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

BinaryFile

GPS track file stored in blob.

BinaryFileFormat

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

ReturnRouteRepresentation

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerCalculateRouteFromGPSTrack</MC_ANSWER_NAME>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<TotalRouteLength>Double</TotalRouteLength>
<Result>Integer</Result>
</ANSWER>

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

BoundingRect TLongLatRect

Geographic coordinates of the rectangles bounding route area.

TotalRouteLength

Total route length in meters.

Result

Returns value from error code table.

RoutePlannerVehicleParamsGet

Returns current vehicle parameters stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerVehicleParamsGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerVehicleParamsGet</MC_ANSWER_NAME>
<VehicleParams>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
</VehicleParams>
<Result>Integer</Result>
</ANSWER>

VehicleParams TVehicleParams

Vehicle parameters.

Result

Returns value from error code table.

RoutePlannerVehicleParamsSet

Sets new vehicle parameters in the session replacing present parameters.

<QUERY>
<MC_QUERY_NAME>RoutePlannerVehicleParamsSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleParams>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
</VehicleParams>
</QUERY>

SessionID

Session identifier.

VehicleParams TVehicleParams

Vehicle parameters.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerVehicleParamsSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerVehicleParamsGet2

Returns current extended vehicle parameters stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerVehicleParamsGet2</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerVehicleParamsGet2</MC_ANSWER_NAME>
<VehicleEntry>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</VehicleEntry>
<Result>Integer</Result>
</ANSWER>

VehicleEntry TVehicleEntry

Vehicle parameters.

Result

Returns value from error code table.

RoutePlannerVehicleParamsSet2

Sets new extended vehicle parameters in the session replacing present parameters.

<QUERY>
<MC_QUERY_NAME>RoutePlannerVehicleParamsSet2</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleEntry>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</VehicleEntry>
</QUERY>

SessionID

Session identifier.

VehicleEntry TVehicleEntry

Vehicle parameters.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerVehicleParamsSet2</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerVehicleParamExGet

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerVehicleParamExGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ParamName>WideString</ParamName>
</QUERY>

SessionID

Session identifier.

ParamName

Parameter name.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerVehicleParamExGet</MC_ANSWER_NAME>
<PasamValue>WideString</PasamValue>
<Result>Integer</Result>
</ANSWER>

PasamValue

Parameter value.

Result

Returns value from error code table.

RoutePlannerVehicleParamsExGet

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerVehicleParamsExGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerVehicleParamsExGet</MC_ANSWER_NAME>
<ParamNames>
<ITEM>WideString</ITEM>
</ParamNames>
<PasamValues>
<ITEM>WideString</ITEM>
</PasamValues>
<Result>Integer</Result>
</ANSWER>

ParamNames TWideStringArray

The list of parameter names.

PasamValues TWideStringArray

The list of corresponding parameter values.

Result

Returns value from error code table.

RoutePlannerVehicleParamExSet

Sets a new value for additional vehicle parameter in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerVehicleParamExSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ParamName>WideString</ParamName>
<PasamValue>WideString</PasamValue>
</QUERY>

SessionID

Session identifier.

ParamName

Parameter name.

PasamValue

Parameter value.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerVehicleParamExSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerDriverParamsGet

Returns current driver parameters stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerDriverParamsGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerDriverParamsGet</MC_ANSWER_NAME>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<Result>Integer</Result>
</ANSWER>

DriverParams TDriverParams

Driver parameters.

Result

Returns value from error code table.

RoutePlannerDriverParamsSet

Sets new driver parameters in the session replacing present parameters.

<QUERY>
<MC_QUERY_NAME>RoutePlannerDriverParamsSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
</QUERY>

SessionID

Session identifier.

DriverParams TDriverParams

Driver parameters.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerDriverParamsSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerRoadParamsGet

Returns current road parameters stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRoadParamsGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRoadParamsGet</MC_ANSWER_NAME>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<Result>Integer</Result>
</ANSWER>

RoadParams TRoadParamsArray

Road parameters.

Result

Returns value from error code table.

RoutePlannerRoadParamsSet

Sets new road parameters in the session replacing present parameters.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRoadParamsSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
</QUERY>

SessionID

Session identifier.

RoadParams TRoadParamsArray

Road parameters.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRoadParamsSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerRoadViaTollParamsGet

Returns current viaTOLL parameters stored in the session.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRoadViaTollParamsGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRoadViaTollParamsGet</MC_ANSWER_NAME>
<ViaTollRoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollRoadParams>
<Result>Integer</Result>
</ANSWER>

ViaTollRoadParams TRoadViaTollParamsArray

viaTOLL parameters.

Result

Returns value from error code table.

RoutePlannerRoadViaTollParamsSet

Sets new viaTOLL parameters in the session replacing present parameters.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRoadViaTollParamsSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ViaTollRoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollRoadParams>
</QUERY>

SessionID

Session identifier.

ViaTollRoadParams TRoadViaTollParamsArray

New viaTOLL parameters.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRoadViaTollParamsSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerGetParamValue

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetParamValue</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ParamName>WideString</ParamName>
</QUERY>

SessionID

Session identifier.

ParamName

Parameter name.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetParamValue</MC_ANSWER_NAME>
<ParamValue>WideString</ParamValue>
<Result>Integer</Result>
</ANSWER>

ParamValue

Parameter value.

Result

Returns value from error code table.

RoutePlannerGetParamValues

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerGetParamValues</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerGetParamValues</MC_ANSWER_NAME>
<ParamNames>
<ITEM>WideString</ITEM>
</ParamNames>
<ParamValues>
<ITEM>WideString</ITEM>
</ParamValues>
<Result>Integer</Result>
</ANSWER>

ParamNames TWideStringArray

Parameter names.

ParamValues TWideStringArray

Parameter values.

Result

Returns value from error code table.

RoutePlannerSetParamValue

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

<QUERY>
<MC_QUERY_NAME>RoutePlannerSetParamValue</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ParamName>WideString</ParamName>
<ParamValue>WideString</ParamValue>
</QUERY>

SessionID

Session identifier.

ParamName

Parameter name.

ParamValue

Parameter value.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerSetParamValue</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerRouteLoadFromBlob

Loads current route from binary representation.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRouteLoadFromBlob</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<BinaryRepresentation>BLOB</BinaryRepresentation>
</QUERY>

SessionID

Session identifier.

BinaryRepresentation

Binary route representation.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRouteLoadFromBlob</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerRouteStoreToBlob

Stores current route to binary representation.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRouteStoreToBlob</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRouteStoreToBlob</MC_ANSWER_NAME>
<BinaryRepresentation>BLOB</BinaryRepresentation>
<Result>Integer</Result>
</ANSWER>

BinaryRepresentation

Returned binary representation.

Result

Returns value from error code table.

RoutePlannerRouteLoadFromDatabase

Loads current route from database.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRouteLoadFromDatabase</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ObjectID>TRecordID</ObjectID>
</QUERY>

SessionID

Session identifier.

ObjectID

Object identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRouteLoadFromDatabase</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RoutePlannerRouteStoreToDatabase

Stores current route to database.

<QUERY>
<MC_QUERY_NAME>RoutePlannerRouteStoreToDatabase</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ObjectID>TRecordID</ObjectID>
</QUERY>

SessionID

Session identifier.

ObjectID

Object identifier.


<ANSWER>
<MC_ANSWER_NAME>RoutePlannerRouteStoreToDatabase</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryClear

Clears the route repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryGetRoutesCount

Returns the count of routes stored int the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryGetRoutesCount</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryGetRoutesCount</MC_ANSWER_NAME>
<Count>Integer</Count>
<Result>Integer</Result>
</ANSWER>

Count

Repository routes count.

Result

Returns value from error code table.

RouteRepositoryGetRoutes

Returns all routes stored in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryGetRoutes</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryGetRoutes</MC_ANSWER_NAME>
<RepositoryRoutes>
<ITEM>
<Ident>Integer</Ident>
<Description>WideString</Description>
<Color>TColor</Color>
<Visible>Boolean</Visible>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
</ITEM>
</RepositoryRoutes>
<Result>Integer</Result>
</ANSWER>

RepositoryRoutes TRepositoryRouteArray

A list of routes.

Result

Returns value from error code table.

RouteRepositoryAddRoute

Adds a new (last calculated) route to the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryAddRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryAddRoute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryAddRouteWithIdent

Adds a new (last calculated) identified route to the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryAddRouteWithIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryAddRouteWithIdent</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryReplaceRoute

Raplaces existing route in the route repository with the last calculated.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryReplaceRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

Index

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


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryReplaceRoute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryReplaceRouteWithIdent

Raplaces existing route in the route repository with the last calculated.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryReplaceRouteWithIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryReplaceRouteWithIdent</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryFetchRoute

Fetches existing route from the repository. It becomes current session route.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryFetchRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

Index

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


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryFetchRoute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryFetchRouteWithIdent

Fetches existing route from the repository. It becomes current session route.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryFetchRouteWithIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryFetchRouteWithIdent</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryRemove

Removes existing route from the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryRemove</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

Index

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


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryRemove</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryRemoveWithIdent

Removes existing route from the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryRemoveWithIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryRemoveWithIdent</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositorySetRouteColor

Sets color for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositorySetRouteColor</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
<Color>Integer</Color>
</QUERY>

SessionID

Session identifier.

Index

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

Color

New route color.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositorySetRouteColor</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositorySetRouteColorByIdent

Sets color for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositorySetRouteColorByIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
<Color>Integer</Color>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.

Color

New route color.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositorySetRouteColorByIdent</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositorySetRouteVisibility

Enables/disables visibility on maps of route existing in the respository.

<QUERY>
<MC_QUERY_NAME>RouteRepositorySetRouteVisibility</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
<Visibility>Boolean</Visibility>
</QUERY>

SessionID

Session identifier.

Index

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

Visibility

Route visibility.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositorySetRouteVisibility</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositorySetRouteVisibilityByIdent

Enables/disables visibility on maps of route existing in the respository.

<QUERY>
<MC_QUERY_NAME>RouteRepositorySetRouteVisibilityByIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
<Visibility>Boolean</Visibility>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.

Visibility

Route visibility.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositorySetRouteVisibilityByIdent</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositorySetRouteDescription

Sets description for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositorySetRouteDescription</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
<Description>WideString</Description>
</QUERY>

SessionID

Session identifier.

Index

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

Description

Route description.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositorySetRouteDescription</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositorySetRouteDescriptionByIdent

Sets description for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositorySetRouteDescriptionByIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
<Description>WideString</Description>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.

Description

Route description.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositorySetRouteDescriptionByIdent</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryGetRouteItinerary

Returns itinerary for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryGetRouteItinerary</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

Index

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


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryGetRouteItinerary</MC_ANSWER_NAME>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<Result>Integer</Result>
</ANSWER>

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events.

Result

Returns value from error code table.

RouteRepositoryGetRouteItineraryByIdent

Returns itinerary for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryGetRouteItineraryByIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryGetRouteItineraryByIdent</MC_ANSWER_NAME>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<Result>Integer</Result>
</ANSWER>

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events.

Result

Returns value from error code table.

RouteRepositoryGetRouteRepresentation

Returns geographic route representation for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryGetRouteRepresentation</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
</QUERY>

SessionID

Session identifier.

Index

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


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryGetRouteRepresentation</MC_ANSWER_NAME>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<Result>Integer</Result>
</ANSWER>

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route.

Result

Returns value from error code table.

RouteRepositoryGetRouteRepresentationByIdent

Returns geographic route representation for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryGetRouteRepresentationByIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryGetRouteRepresentationByIdent</MC_ANSWER_NAME>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<Result>Integer</Result>
</ANSWER>

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route.

Result

Returns value from error code table.

RouteRepositoryGetRouteSummary

Returns summary for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryGetRouteSummary</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Index>Integer</Index>
<ReturnRoadResults>Boolean</ReturnRoadResults>
</QUERY>

SessionID

Session identifier.

Index

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

ReturnRoadResults

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


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryGetRouteSummary</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<RouteCalculateType>Integer</RouteCalculateType>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

RouteCalculateType

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

Result

Returns value from error code table.

RouteRepositoryGetRouteSummaryByIdent

Returns summary for route existing in the repository.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryGetRouteSummaryByIdent</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Ident>Integer</Ident>
<ReturnRoadResults>Boolean</ReturnRoadResults>
</QUERY>

SessionID

Session identifier.

Ident

Route identifier.

ReturnRoadResults

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


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryGetRouteSummaryByIdent</MC_ANSWER_NAME>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<RouteCalculateType>Integer</RouteCalculateType>
<Result>Integer</Result>
</ANSWER>

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

RouteCalculateType

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

Result

Returns value from error code table.

RouteRepositoryLoadFromBlob

Loads route repository from binary representation.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryLoadFromBlob</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<BinaryRepresentation>BLOB</BinaryRepresentation>
</QUERY>

SessionID

Session identifier.

BinaryRepresentation

Binary representation of route repository.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryLoadFromBlob</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteRepositoryStoreToBlob

Stores route repository to binary representation.

<QUERY>
<MC_QUERY_NAME>RouteRepositoryStoreToBlob</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryStoreToBlob</MC_ANSWER_NAME>
<BinaryRepresentation>BLOB</BinaryRepresentation>
<Result>Integer</Result>
</ANSWER>

BinaryRepresentation

Returned binary representation of route repository.

Result

Returns value from error code table.

RouteRepositoryCalculatePointDistanceFromRoute

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

<QUERY>
<MC_QUERY_NAME>RouteRepositoryCalculatePointDistanceFromRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<MaxLength>Double</MaxLength>
<Points>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Points>
</QUERY>

SessionID

Session identifier.

MaxLength

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

Points TLongLatPointArray

A list of points.


<ANSWER>
<MC_ANSWER_NAME>RouteRepositoryCalculatePointDistanceFromRoute</MC_ANSWER_NAME>
<DistanceFromRoutes>
<ITEM>
<ITEM>Double</ITEM>
</ITEM>
</DistanceFromRoutes>
<RoutesIdents>
<ITEM>Integer</ITEM>
</RoutesIdents>
<Result>Integer</Result>
</ANSWER>

DistanceFromRoutes TFloatArrayArray

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.

RoutesIdents TDynamicIntegerArray

Resultant list of repository identifiers.

Result

Returns value from error code table.

RouteAttributesClearRouteAttribute

Removes all routing difficulties stored in the session.

<QUERY>
<MC_QUERY_NAME>RouteAttributesClearRouteAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesClearRouteAttribute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesAddPointAttribute

Adds new point routing difficulty to the session.

<QUERY>
<MC_QUERY_NAME>RouteAttributesAddPointAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Position>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</Position>
<AttributeParams>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</AttributeParams>
<GenerateID>Boolean</GenerateID>
</QUERY>

SessionID

Session identifier.

Position TLongLatPoint

Geographic coordinates of the difficulty.

AttributeParams TRouteAttributeParams

Difficulty properties.

GenerateID

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


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesAddPointAttribute</MC_ANSWER_NAME>
<AttributeID>Integer</AttributeID>
<Result>Integer</Result>
</ANSWER>

AttributeID

Auto-generated difficulty identifier. Essential if GenerateID option was set to true.

Result

Returns value from error code table.

RouteAttributesAddLineAttribute

Adds new polyline routing difficulty to the session.

<QUERY>
<MC_QUERY_NAME>RouteAttributesAddLineAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Line>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Line>
<AttributeParams>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</AttributeParams>
<GenerateID>Boolean</GenerateID>
</QUERY>

SessionID

Session identifier.

Line TLongLatPointArray

Geographic coordinates of all points of the difficulty polyline.

AttributeParams TRouteAttributeParams

Difficulty properties.

GenerateID

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


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesAddLineAttribute</MC_ANSWER_NAME>
<AttributeID>Integer</AttributeID>
<Result>Integer</Result>
</ANSWER>

AttributeID

Auto-generated difficulty identifier. Essential if GenerateID option was set to true.

Result

Returns value from error code table.

RouteAttributesAddPolygonAttribute

Adds new polygonal routing difficulty to the session.

<QUERY>
<MC_QUERY_NAME>RouteAttributesAddPolygonAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Polygon>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Polygon>
<AttributeParams>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</AttributeParams>
<GenerateID>Boolean</GenerateID>
</QUERY>

SessionID

Session identifier.

Polygon TLongLatPointArray

Geographic coordinates of all points of the difficulty polygon.

AttributeParams TRouteAttributeParams

Difficulty properties.

GenerateID

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


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesAddPolygonAttribute</MC_ANSWER_NAME>
<AttributeID>Integer</AttributeID>
<Result>Integer</Result>
</ANSWER>

AttributeID

Auto-generated difficulty identifier. Essential if GenerateID option was set to true.

Result

Returns value from error code table.

RouteAttributesAddAlongRouteAttribute

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

<QUERY>
<MC_QUERY_NAME>RouteAttributesAddAlongRouteAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<StartPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</StartPoint>
<FinishPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FinishPoint>
<AttributeParams>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</AttributeParams>
<GenerateID>Boolean</GenerateID>
<ReturnRepresentation>Boolean</ReturnRepresentation>
</QUERY>

SessionID

Session identifier.

StartPoint TLongLatPoint

Geographic coordinates of the difficulty start point.

FinishPoint TLongLatPoint

Geographic coordinates of the difficulty finish point.

AttributeParams TRouteAttributeParams

Difficulty properties.

GenerateID

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

ReturnRepresentation

Option of returning all points of generated polyline.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesAddAlongRouteAttribute</MC_ANSWER_NAME>
<AttributeID>Integer</AttributeID>
<Representation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Representation>
<Result>Integer</Result>
</ANSWER>

AttributeID

Auto-generated difficulty identifier. Essential if GenerateID option was set to true.

Representation TLongLatPointArray

All points of generated polyline (if ReturnRepresentation option was set to true).

Result

Returns value from error code table.

RouteAttributesModifyPointAttribute

Modifies geographic properties of point routing difficulty identified by given identifier.

<QUERY>
<MC_QUERY_NAME>RouteAttributesModifyPointAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AttributeID>Integer</AttributeID>
<Position>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</Position>
</QUERY>

SessionID

Session identifier.

AttributeID

Identifier of difficulty being modified.

Position TLongLatPoint

New coordinates.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesModifyPointAttribute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesModifyLineAttribute

Modifies geographic properties of polyline routing difficulty identified by given identifier.

<QUERY>
<MC_QUERY_NAME>RouteAttributesModifyLineAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AttributeID>Integer</AttributeID>
<Line>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Line>
</QUERY>

SessionID

Session identifier.

AttributeID

Identifier of difficulty being modified.

Line TLongLatPointArray

New coordinates.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesModifyLineAttribute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesModifyPolygonAttribute

Modifies geographic properties of polygonal routing difficulty identified by given identifier.

<QUERY>
<MC_QUERY_NAME>RouteAttributesModifyPolygonAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AttributeID>Integer</AttributeID>
<Polygon>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Polygon>
</QUERY>

SessionID

Session identifier.

AttributeID

Identifier of difficulty being modified.

Polygon TLongLatPointArray

New coordinates.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesModifyPolygonAttribute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesModifyAlongRouteAttribute

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

<QUERY>
<MC_QUERY_NAME>RouteAttributesModifyAlongRouteAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AttributeID>Integer</AttributeID>
<StartPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</StartPoint>
<FinishPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FinishPoint>
<ReturnRepresentation>Boolean</ReturnRepresentation>
</QUERY>

SessionID

Session identifier.

AttributeID

Identifier of difficulty being modified.

StartPoint TLongLatPoint

New start point coordinates.

FinishPoint TLongLatPoint

New finish point coordinates.

ReturnRepresentation

Option of returning all points of generated polyline.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesModifyAlongRouteAttribute</MC_ANSWER_NAME>
<Representation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Representation>
<Result>Integer</Result>
</ANSWER>

Representation TLongLatPointArray

All points of generated polyline (if ReturnRepresentation option was set to true).

Result

Returns value from error code table.

RouteAttributesSetRouteAttribute

Modifies properties of routing difficulty identified by given identifier.

<QUERY>
<MC_QUERY_NAME>RouteAttributesSetRouteAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AttributeID>Integer</AttributeID>
<AttributeParams>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</AttributeParams>
</QUERY>

SessionID

Session identifier.

AttributeID

Identifier of difficulty being modified.

AttributeParams TRouteAttributeParams

New difficulty properties.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesSetRouteAttribute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesDeleteRouteAttribute

Removes routing difficulty identified by given identifier.

<QUERY>
<MC_QUERY_NAME>RouteAttributesDeleteRouteAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AttributeID>Integer</AttributeID>
</QUERY>

SessionID

Session identifier.

AttributeID

Identifier of difficulty being deleted.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesDeleteRouteAttribute</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesGetRouteAttribute

Returns properties of routing difficulty identified by given identifier.

<QUERY>
<MC_QUERY_NAME>RouteAttributesGetRouteAttribute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AttributeID>Integer</AttributeID>
</QUERY>

SessionID

Session identifier.

AttributeID

Identifier of difficulty.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesGetRouteAttribute</MC_ANSWER_NAME>
<Attribute>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</Attribute>
<Result>Integer</Result>
</ANSWER>

Attribute TRouteAttributeParams

Difficulty properties.

Result

Returns value from error code table.

RouteAttributesGetRouteAttributeWithGeometry

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

<QUERY>
<MC_QUERY_NAME>RouteAttributesGetRouteAttributeWithGeometry</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<AttributeID>Integer</AttributeID>
</QUERY>

SessionID

Session identifier.

AttributeID

Identifier of difficulty.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesGetRouteAttributeWithGeometry</MC_ANSWER_NAME>
<Attribute>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</Attribute>
<GeometryKind>Integer</GeometryKind>
<Geometry>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</Geometry>
<Result>Integer</Result>
</ANSWER>

Attribute TRouteAttributeParams

Difficulty properties.

GeometryKind

Difficulty geometry kind:
- point = 0x00
- road-along placed polyline = 0x01
- polyline = 0x02
- polygon = 0x03
- none = 0x04

Geometry TLongLatPointArray

A list of all difficulty points (number of point is dependent on difficulty geometry kind).

Result

Returns value from error code table.

RouteAttributesGetRouteAttributes

Returns all routing difficulties stored in the session.

<QUERY>
<MC_QUERY_NAME>RouteAttributesGetRouteAttributes</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesGetRouteAttributes</MC_ANSWER_NAME>
<AttributesList>
<ITEM>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</ITEM>
</AttributesList>
<Result>Integer</Result>
</ANSWER>

AttributesList TRouteAttributeParamsArray

A list of routing difficulties.

Result

Returns value from error code table.

RouteAttributesLoadFromBlob

Loads routing difficulties from binary representation.

<QUERY>
<MC_QUERY_NAME>RouteAttributesLoadFromBlob</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<BinaryRepresentation>BLOB</BinaryRepresentation>
</QUERY>

SessionID

Session identifier.

BinaryRepresentation

Binary representation of routing difficulties.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesLoadFromBlob</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesStoreToBlob

Stores all routing difficulties to binary representation.

<QUERY>
<MC_QUERY_NAME>RouteAttributesStoreToBlob</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesStoreToBlob</MC_ANSWER_NAME>
<BinaryRepresentation>BLOB</BinaryRepresentation>
<Result>Integer</Result>
</ANSWER>

BinaryRepresentation

Returned binary representation of routing difficulties.

Result

Returns value from error code table.

RouteAttributesGetAttributesProviderList

Returns a list of supported routing difficulty providers.

<QUERY>
<MC_QUERY_NAME>RouteAttributesGetAttributesProviderList</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesGetAttributesProviderList</MC_ANSWER_NAME>
<ProvidersList>
<ITEM>WideString</ITEM>
</ProvidersList>
<Result>Integer</Result>
</ANSWER>

ProvidersList TWideStringArray

A list of providers.

Result

Returns value from error code table.

RouteAttributesGetSubscribedProvidersList

Returns a list of currently subscribed routing difficulty providers.

<QUERY>
<MC_QUERY_NAME>RouteAttributesGetSubscribedProvidersList</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesGetSubscribedProvidersList</MC_ANSWER_NAME>
<SubscribedProvidersList>
<ITEM>WideString</ITEM>
</SubscribedProvidersList>
<Result>Integer</Result>
</ANSWER>

SubscribedProvidersList TWideStringArray

A list of subscribed providers.

Result

Returns value from error code table.

RouteAttributesSubscribeToDataProvider

Subcribes to one of supported routing difficulty providers.

<QUERY>
<MC_QUERY_NAME>RouteAttributesSubscribeToDataProvider</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Provider>WideString</Provider>
</QUERY>

SessionID

Session identifier.

Provider

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


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesSubscribeToDataProvider</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesUnsubscribeFromDataProvider

Unsubcribes from one of subscribed routing difficulty providers.

<QUERY>
<MC_QUERY_NAME>RouteAttributesUnsubscribeFromDataProvider</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Provider>WideString</Provider>
</QUERY>

SessionID

Session identifier.

Provider

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


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesUnsubscribeFromDataProvider</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesGetDataProviderParams

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

<QUERY>
<MC_QUERY_NAME>RouteAttributesGetDataProviderParams</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Provider>WideString</Provider>
</QUERY>

SessionID

Session identifier.

Provider

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


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesGetDataProviderParams</MC_ANSWER_NAME>
<ParamNames>
<ITEM>WideString</ITEM>
</ParamNames>
<ParamValues>
<ITEM>WideString</ITEM>
</ParamValues>
<Result>Integer</Result>
</ANSWER>

ParamNames TWideStringArray

Parameter names.

ParamValues TWideStringArray

Parameter values.

Result

Returns value from error code table.

RouteAttributesSetDataProviderParam

Sets a value for given parameter of routing difficulty provider.

<QUERY>
<MC_QUERY_NAME>RouteAttributesSetDataProviderParam</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Provider>WideString</Provider>
<ParamName>WideString</ParamName>
<ParamValue>WideString</ParamValue>
</QUERY>

SessionID

Session identifier.

Provider

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

ParamName

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

ParamValue

Parameter value.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesSetDataProviderParam</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesGetDataProviderActions

Returns all actions supported for given routing difficulty provider.

<QUERY>
<MC_QUERY_NAME>RouteAttributesGetDataProviderActions</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Provider>WideString</Provider>
</QUERY>

SessionID

Session identifier.

Provider

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


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesGetDataProviderActions</MC_ANSWER_NAME>
<ActionNames>
<ITEM>WideString</ITEM>
</ActionNames>
<Result>Integer</Result>
</ANSWER>

ActionNames TWideStringArray

Action names.

Result

Returns value from error code table.

RouteAttributesExecuteDataProviderAction

Executes one of the action supported for given routing difficulty provider.

<QUERY>
<MC_QUERY_NAME>RouteAttributesExecuteDataProviderAction</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Provider>WideString</Provider>
<ActionName>WideString</ActionName>
<ActionParams>
<ITEM>WideString</ITEM>
</ActionParams>
</QUERY>

SessionID

Session identifier.

Provider

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

ActionName

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

ActionParams TWideStringArray

Action params. For future use.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesExecuteDataProviderAction</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteAttributesGetPassedAttributesList

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

<QUERY>
<MC_QUERY_NAME>RouteAttributesGetPassedAttributesList</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteAttributesGetPassedAttributesList</MC_ANSWER_NAME>
<VisitedAttributes>
<ITEM>
<SubscriberName>WideString</SubscriberName>
<AttributeID>Integer</AttributeID>
<MiddlePosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePosition>
<BlockReasonBits>Integer</BlockReasonBits>
</ITEM>
</VisitedAttributes>
<BlockedAttributes>
<ITEM>
<SubscriberName>WideString</SubscriberName>
<AttributeID>Integer</AttributeID>
<MiddlePosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePosition>
<BlockReasonBits>Integer</BlockReasonBits>
</ITEM>
</BlockedAttributes>
<Result>Integer</Result>
</ANSWER>

VisitedAttributes TRouteAttributePassedArray

List of the difficulties which were taken into account but haven't influenced on the last calculated route.

BlockedAttributes TRouteAttributePassedArray

List of the difficulties which have influenced on the last calculated route.

Result

Returns value from error code table.

RouteOptimizerSimpleOptimizeRoute

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.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerSimpleOptimizeRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RoutePlanEntries>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RoutePlanEntries>
<VehicleParams>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
</VehicleParams>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<RouteCalculateType>Integer</RouteCalculateType>
<RouteOptimizeType>Integer</RouteOptimizeType>
<CalculateRoute>Boolean</CalculateRoute>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<StoreDriverParamsInSession>Boolean</StoreDriverParamsInSession>
<StoreVehicleParamsInSession>Boolean</StoreVehicleParamsInSession>
<StoreRoadParamsInSession>Boolean</StoreRoadParamsInSession>
<StoreRoutePlanEntriesInSession>Boolean</StoreRoutePlanEntriesInSession>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RoutePlanEntries TLongLatPointArray

A list of geographic coordinates of waypoints.

VehicleParams TVehicleParams

Vehicle parameters.

DriverParams TDriverParams

Driver parameters.

RoadParams TRoadParamsArray

Road parameters.

RouteCalculateType

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

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

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.

ReturnRoutePlanEntriesDescription

Option of returning automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

StoreDriverParamsInSession

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

StoreVehicleParamsInSession

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

StoreRoadParamsInSession

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

StoreRoutePlanEntriesInSession

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerSimpleOptimizeRoute</MC_ANSWER_NAME>
<CyclePoints>
<ITEM>
<SourceEntryIndex>Integer</SourceEntryIndex>
<DestinationEntryIndex>Integer</DestinationEntryIndex>
<DroppedEntry>Boolean</DroppedEntry>
<DayAssigment>Integer</DayAssigment>
<DriverAssigment>Integer</DriverAssigment>
</ITEM>
</CyclePoints>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

CyclePoints TRouteOptimalizationEntryArray

Properties of the waypoint entries after optimization process.

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RouteOptimizerOptimizeRoute

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.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerOptimizeRoute</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<RouteCalculateType>Integer</RouteCalculateType>
<RouteOptimizeType>Integer</RouteOptimizeType>
<CalculateRoute>Boolean</CalculateRoute>
<ReorderPoints>Boolean</ReorderPoints>
<ReturnRoutePlanEntriesDescription>Boolean</ReturnRoutePlanEntriesDescription>
<ReturnRouteRepresentation>Boolean</ReturnRouteRepresentation>
<ReturnRouteItinerary>Boolean</ReturnRouteItinerary>
<ReturnRoadResults>Boolean</ReturnRoadResults>
<StoreRouteInSession>Boolean</StoreRouteInSession>
</QUERY>

SessionID

Session identifier.

RouteCalculateType

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

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

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.

ReorderPoints

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

ReturnRoutePlanEntriesDescription

Option of returning user or automatic generated geographical waypoint descriptons.

ReturnRouteRepresentation

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

ReturnRouteItinerary

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

ReturnRoadResults

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

StoreRouteInSession

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerOptimizeRoute</MC_ANSWER_NAME>
<CyclePoints>
<ITEM>
<SourceEntryIndex>Integer</SourceEntryIndex>
<DestinationEntryIndex>Integer</DestinationEntryIndex>
<DroppedEntry>Boolean</DroppedEntry>
<DayAssigment>Integer</DayAssigment>
<DriverAssigment>Integer</DriverAssigment>
</ITEM>
</CyclePoints>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<RoadResults>
<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>
</RoadResults>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<RouteRepresentation>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</RouteRepresentation>
<RouteItinerary>
<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>
</RouteItinerary>
<RoutePlanEntriesDescription>
<ITEM>WideString</ITEM>
</RoutePlanEntriesDescription>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
<UnreachableEntry>Integer</UnreachableEntry>
<Result>Integer</Result>
</ANSWER>

CyclePoints TRouteOptimalizationEntryArray

Properties of the waypoint entries after optimization process.

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost.

TotalFuelCost

Total fuel cost.

RoadResults TRoadResultsArray

Route results divided into separated road types.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

RouteRepresentation TLongLatPointArray

Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.

RouteItinerary TRouteItineraryArray

Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.

RoutePlanEntriesDescription TWideStringArray

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.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

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.

Result

Returns value from error code table.

RouteOptimizerAddShipmentType

Defines within the server session a new shipment type which is identified by an arbitrary name.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerAddShipmentType</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ShipmentType>WideString</ShipmentType>
</QUERY>

SessionID

Session identifier.

ShipmentType

Name of the shipment type.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerAddShipmentType</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerRemoveShipmentType

Deletes one of defined shipment types.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerRemoveShipmentType</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ShipmentType>WideString</ShipmentType>
</QUERY>

SessionID

Session identifier.

ShipmentType

Name of the shipment type to be deleted.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerRemoveShipmentType</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerShipmentTypesGet

Returns a list of currently defined shipment types.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerShipmentTypesGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerShipmentTypesGet</MC_ANSWER_NAME>
<ShipmentTypes>
<ITEM>WideString</ITEM>
</ShipmentTypes>
<Result>Integer</Result>
</ANSWER>

ShipmentTypes TWideStringArray

Resultant list of shipment types.

Result

Returns value from error code table.

RouteOptimizerShipmentTypesSet

Sets for the server session a new set of shipment types replacing existing one, if present.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerShipmentTypesSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ShipmentTypes>
<ITEM>WideString</ITEM>
</ShipmentTypes>
</QUERY>

SessionID

Session identifier.

ShipmentTypes TWideStringArray

A list of new shipment types.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerShipmentTypesSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerShipmentTypesClear

Removes all shipment types defined in the server session.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerShipmentTypesClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerShipmentTypesClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerSetDepotEntry

Marks one of the waypoints defined in the server session as a depot.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerSetDepotEntry</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<DepotEntryIndex>Integer</DepotEntryIndex>
</QUERY>

SessionID

Session identifier.

DepotEntryIndex

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerSetDepotEntry</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerGetDepotEntry

Gets the index of currently set depot waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerGetDepotEntry</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerGetDepotEntry</MC_ANSWER_NAME>
<DepotEntryIndex>Integer</DepotEntryIndex>
<Result>Integer</Result>
</ANSWER>

DepotEntryIndex

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

Result

Returns value from error code table.

RouteOptimizerGetEntryTimeWindows

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

<QUERY>
<MC_QUERY_NAME>RouteOptimizerGetEntryTimeWindows</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

EntryIndex

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerGetEntryTimeWindows</MC_ANSWER_NAME>
<TimeWindows>
<ITEM>
<TimeFrom>Double</TimeFrom>
<TimeTo>Double</TimeTo>
</ITEM>
</TimeWindows>
<Result>Integer</Result>
</ANSWER>

TimeWindows TTimeWindowsArray

Resultant list of time windows defined for a waypoint.

Result

Returns value from error code table.

RouteOptimizerClearEntryTimeWindows

Deletes all time windows defined for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerClearEntryTimeWindows</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

EntryIndex

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerClearEntryTimeWindows</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerAddEntryTimeWindow

Adds a new time window for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerAddEntryTimeWindow</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<TimeWindow>
<TimeFrom>Double</TimeFrom>
<TimeTo>Double</TimeTo>
</TimeWindow>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

TimeWindow TTimeWindow

New time window definition.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerAddEntryTimeWindow</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerAddEntryTimeWindows

Adds a list of time windows for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerAddEntryTimeWindows</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<TimeWindows>
<ITEM>
<TimeFrom>Double</TimeFrom>
<TimeTo>Double</TimeTo>
</ITEM>
</TimeWindows>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

TimeWindows TTimeWindowsArray

A list of new time window definitions.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerAddEntryTimeWindows</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerSetEntryTimeWindows

Sets a new set of time windows for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerSetEntryTimeWindows</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<TimeWindows>
<ITEM>
<TimeFrom>Double</TimeFrom>
<TimeTo>Double</TimeTo>
</ITEM>
</TimeWindows>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

TimeWindows TTimeWindowsArray

A list of time window definitions.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerSetEntryTimeWindows</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerGetEntryDeliveryShipments

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

<QUERY>
<MC_QUERY_NAME>RouteOptimizerGetEntryDeliveryShipments</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

EntryIndex

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerGetEntryDeliveryShipments</MC_ANSWER_NAME>
<DeliveryShipments>
<ITEM>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</ITEM>
</DeliveryShipments>
<Result>Integer</Result>
</ANSWER>

DeliveryShipments TShipmentsArray

Resultant list of delivery shipments defined for a waypoint.

Result

Returns value from error code table.

RouteOptimizerAddEntryDeliveryShipment

Adds a new delivery shipment for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerAddEntryDeliveryShipment</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<DeliveryShipment>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</DeliveryShipment>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

DeliveryShipment TShipment

New delivery shipment definition.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerAddEntryDeliveryShipment</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerAddEntryDeliveryShipments

Adds a list of delivery shipments for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerAddEntryDeliveryShipments</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<DeliveryShipments>
<ITEM>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</ITEM>
</DeliveryShipments>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

DeliveryShipments TShipmentsArray

A list of new delivery shipments definitions.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerAddEntryDeliveryShipments</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerClearEntryDeliveryShipments

Deletes all delivery shipments defined for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerClearEntryDeliveryShipments</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

EntryIndex

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerClearEntryDeliveryShipments</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerSetEntryDeliveryShipments

Sets a new set of delivery shipments for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerSetEntryDeliveryShipments</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<DeliveryShipments>
<ITEM>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</ITEM>
</DeliveryShipments>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

DeliveryShipments TShipmentsArray

A list of delivery shipment definitions.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerSetEntryDeliveryShipments</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerGetEntryPickupShipments

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

<QUERY>
<MC_QUERY_NAME>RouteOptimizerGetEntryPickupShipments</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

EntryIndex

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerGetEntryPickupShipments</MC_ANSWER_NAME>
<PickupShipments>
<ITEM>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</ITEM>
</PickupShipments>
<Result>Integer</Result>
</ANSWER>

PickupShipments TShipmentsArray

Resultant list of pickup shipments defined for a waypoint.

Result

Returns value from error code table.

RouteOptimizerAddEntryPickupShipment

Adds a new pickup shipment for a waypoint. For future use.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerAddEntryPickupShipment</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<PickupShipment>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</PickupShipment>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

PickupShipment TShipment

New pickup shipment definition.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerAddEntryPickupShipment</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerAddEntryPickupShipments

Adds a list of pickup shipments for a waypoint. For future use.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerAddEntryPickupShipments</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<PickupShipments>
<ITEM>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</ITEM>
</PickupShipments>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

PickupShipments TShipmentsArray

A list of new pickup shipment definitions.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerAddEntryPickupShipments</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerClearEntryPickupShipments

Deletes all pickup shipments defined for a waypoint. For future use.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerClearEntryPickupShipments</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

EntryIndex

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerClearEntryPickupShipments</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerSetEntryPickupShipments

Sets a new set of pickup shipments for a waypoint. For future use.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerSetEntryPickupShipments</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<PickupShipments>
<ITEM>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</ITEM>
</PickupShipments>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

PickupShipments TShipmentsArray

A list of pickup shipment definitions.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerSetEntryPickupShipments</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerGetEntryShipmentDeliveryPickupTimes

Returns delivery and pickup times defined for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerGetEntryShipmentDeliveryPickupTimes</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
</QUERY>

SessionID

Session identifier.

EntryIndex

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerGetEntryShipmentDeliveryPickupTimes</MC_ANSWER_NAME>
<DeliveryTime>Integer</DeliveryTime>
<PickupTime>Integer</PickupTime>
<Result>Integer</Result>
</ANSWER>

DeliveryTime

Time of shipment delivery (in minutes).

PickupTime

Time of shipment pickup (in minutes).

Result

Returns value from error code table.

RouteOptimizerSetEntryShipmentDeliveryPickupTimes

Sets new delivery and pickup times for a waypoint.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerSetEntryShipmentDeliveryPickupTimes</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<EntryIndex>Integer</EntryIndex>
<DeliveryTime>Integer</DeliveryTime>
<PickupTime>Integer</PickupTime>
</QUERY>

SessionID

Session identifier.

EntryIndex

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

DeliveryTime

Time of shipment delivery (in minutes).

PickupTime

Time of shipment pickup (in minutes).


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerSetEntryShipmentDeliveryPickupTimes</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear

Deletes entire list of incompatibilities between vehicle categories and shipment types.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd

Adds a new entry to the list of incompatibilities between vehicle categories and shipment types defined in the server session.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleCategory>WideString</VehicleCategory>
<ShipmentType>WideString</ShipmentType>
</QUERY>

SessionID

Session identifier.

VehicleCategory

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

ShipmentType

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet

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

<QUERY>
<MC_QUERY_NAME>RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet</MC_ANSWER_NAME>
<VehicleCategoryToShipmentTypeIncompatibility>
<ITEM>
<VehicleCategory>WideString</VehicleCategory>
<ShipmentType>WideString</ShipmentType>
</ITEM>
</VehicleCategoryToShipmentTypeIncompatibility>
<Result>Integer</Result>
</ANSWER>

VehicleCategoryToShipmentTypeIncompatibility TVehicleCategoryToShipmentTypeIncompatibilityArray

Resultant list of incompatibility pairs.

Result

Returns value from error code table.

RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet

Sets a new set of incompatibilities between vehicle categories and shipment types.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleCategoryToShipmentTypeIncompatibility>
<ITEM>
<VehicleCategory>WideString</VehicleCategory>
<ShipmentType>WideString</ShipmentType>
</ITEM>
</VehicleCategoryToShipmentTypeIncompatibility>
</QUERY>

SessionID

Session identifier.

VehicleCategoryToShipmentTypeIncompatibility TVehicleCategoryToShipmentTypeIncompatibilityArray

A list of incompatibility pairs.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear

Deletes entire list of incompatibilities between some two shipment types.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd

Adds a new entry to the list of incompatibilities between some two shipment types defined in the server session.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ShipmentType1>WideString</ShipmentType1>
<ShipmentType2>WideString</ShipmentType2>
</QUERY>

SessionID

Session identifier.

ShipmentType1

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

ShipmentType2

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


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet

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

<QUERY>
<MC_QUERY_NAME>RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet</MC_ANSWER_NAME>
<ShipmentTypeToShipmentTypeIncompatibility>
<ITEM>
<ShipmentType1>WideString</ShipmentType1>
<ShipmentType2>WideString</ShipmentType2>
</ITEM>
</ShipmentTypeToShipmentTypeIncompatibility>
<Result>Integer</Result>
</ANSWER>

ShipmentTypeToShipmentTypeIncompatibility TShipmentTypeToShipmentTypeIncompatibilityArray

Resultant list of incompatibility pairs.

Result

Returns value from error code table.

RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet

Sets a new set of incompatibilities between shipment types.

<QUERY>
<MC_QUERY_NAME>RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ShipmentTypeToShipmentTypeIncompatibility>
<ITEM>
<ShipmentType1>WideString</ShipmentType1>
<ShipmentType2>WideString</ShipmentType2>
</ITEM>
</ShipmentTypeToShipmentTypeIncompatibility>
</QUERY>

SessionID

Session identifier.

ShipmentTypeToShipmentTypeIncompatibility TShipmentTypeToShipmentTypeIncompatibilityArray

A list of incompatibility pairs.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

RouteOptimizerSolveProblem

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

<QUERY>
<MC_QUERY_NAME>RouteOptimizerSolveProblem</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>RouteOptimizerSolveProblem</MC_ANSWER_NAME>
<SolutionCost>Integer</SolutionCost>
<Routes>
<ITEM>
<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<Cost>Integer</Cost>
<VehicleCategory>WideString</VehicleCategory>
</ITEM>
</Routes>
<ShipmentMoves>
<ITEM>
<ResultRouteInfoIndex>Integer</ResultRouteInfoIndex>
<ShipmentId>WideString</ShipmentId>
<PickupEntryIndex>Integer</PickupEntryIndex>
<DeliveryEntryIndex>Integer</DeliveryEntryIndex>
<LoadCapacitySize>Integer</LoadCapacitySize>
<LoadCapacityWeight>Integer</LoadCapacityWeight>
</ITEM>
</ShipmentMoves>
<Entries>
<ITEM>
<ResultRouteInfoIndex>Integer</ResultRouteInfoIndex>
<FromEntryIndex>Integer</FromEntryIndex>
<ToEntryIndex>Integer</ToEntryIndex>
<Duration>Integer</Duration>
<Arrival>Integer</Arrival>
<Wait>Integer</Wait>
<ShortBreak>Integer</ShortBreak>
</ITEM>
</Entries>
<ShipmentDeliveries>
<ITEM>
<EntryIndex>Integer</EntryIndex>
<IsFromEntry>Boolean</IsFromEntry>
<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<ShipmentId>WideString</ShipmentId>
</ITEM>
</ShipmentDeliveries>
<ShipmentPickups>
<ITEM>
<EntryIndex>Integer</EntryIndex>
<IsFromEntry>Boolean</IsFromEntry>
<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<ShipmentId>WideString</ShipmentId>
</ITEM>
</ShipmentPickups>
<Result>Integer</Result>
</ANSWER>

SolutionCost

Total cost of all routes in hundreth parts of the main currency.

Routes TRouteOptimizerResultRoutesArray

A list of all resultant routes.

ShipmentMoves TRouteOptimizerShipmentMovesArray

A list of shipment events for all routes.

Entries TRouteOptimizerEntryArray

A list of all route segments.

ShipmentDeliveries TRouteOptimizerShipmentActionArray

A list of all resultant delivery shipment actions.

ShipmentPickups TRouteOptimizerShipmentActionArray

A list of all resultant pickup shipment actions.

Result

Returns value from error code table.

VehicleRepositoryAddVehicle

Defines a new vehicle within the server session's vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryAddVehicle</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Vehicle>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</Vehicle>
</QUERY>

SessionID

Session identifier.

Vehicle TVehicleEntry

A new vehicle parameters.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryAddVehicle</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryRemoveVehicle

Deletes one of the vehicles stored in the session's vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryRemoveVehicle</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryRemoveVehicle</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryVehicleGet

Returns parameters of one of the vehicles stored in the session's vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehicleGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehicleGet</MC_ANSWER_NAME>
<Vehicle>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</Vehicle>
<Result>Integer</Result>
</ANSWER>

Vehicle TVehicleEntry

Parameters of the vehicle.

Result

Returns value from error code table.

VehicleRepositoryVehicleSet

Sets new vehicle parameters in the session's vehicle repository replacing present parameters.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehicleSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
<Vehicle>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</Vehicle>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

Vehicle TVehicleEntry

New parameters of the vehicle.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehicleSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryRoadParamsGet

Returns current road parameters of one of the vehicles stored in the session's vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryRoadParamsGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryRoadParamsGet</MC_ANSWER_NAME>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
<Result>Integer</Result>
</ANSWER>

RoadParams TRoadParamsArray

Road parameters.

Result

Returns value from error code table.

VehicleRepositoryRoadParamsSet

Sets new road parameters for given vehicle stored in the repository replacing present parameters.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryRoadParamsSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
<RoadParams>
<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>
</RoadParams>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

RoadParams TRoadParamsArray

Road parameters.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryRoadParamsSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryVehicleViaTollGet

Returns current viaTOLL parameters of one of the vehicles stored in the session's vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehicleViaTollGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehicleViaTollGet</MC_ANSWER_NAME>
<ViaTollParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollParams>
<Result>Integer</Result>
</ANSWER>

ViaTollParams TRoadViaTollParamsArray

Parameters of the vehicle.

Result

Returns value from error code table.

VehicleRepositoryVehicleViaTollSet

Sets new viaTOLL parameters for given vehicle stored in the repository replacing present parameters.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehicleViaTollSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
<ViaTollParams>
<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>
</ViaTollParams>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

ViaTollParams TRoadViaTollParamsArray

New parameters of the vehicle.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehicleViaTollSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryDriverParamsGet

Returns current driver parameters of one of the vehicles stored in the session's vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryDriverParamsGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryDriverParamsGet</MC_ANSWER_NAME>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
<Result>Integer</Result>
</ANSWER>

DriverParams TDriverParams

Driver parameters.

Result

Returns value from error code table.

VehicleRepositoryDriverParamsSet

Sets new driver parameters for given vehicle stored in the repository replacing present parameters.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryDriverParamsSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
<DriverParams>
<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
</DriverParams>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.

DriverParams TDriverParams

Driver parameters.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryDriverParamsSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryVehicleFetch

Fetches existing vehicle with all its parameters from the repository. The vehicle and its road parameters become current session parameters for routing.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehicleFetch</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehicleFetch</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryVehicleReplace

Raplaces all parameters of one of the vehicle in the repository with current vehicle and road parameters stored in the session.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehicleReplace</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<VehicleIndex>Integer</VehicleIndex>
</QUERY>

SessionID

Session identifier.

VehicleIndex

Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehicleReplace</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryVehiclesGet

Returns a list of all vehicles stored in the session's vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehiclesGet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehiclesGet</MC_ANSWER_NAME>
<Vehicles>
<ITEM>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</ITEM>
</Vehicles>
<Result>Integer</Result>
</ANSWER>

Vehicles TVehicleEntryArray

Resultant list of vehicles.

Result

Returns value from error code table.

VehicleRepositoryVehiclesSet

Sets a new set of vehicles in the vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehiclesSet</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<Vehicles>
<ITEM>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</ITEM>
</Vehicles>
</QUERY>

SessionID

Session identifier.

Vehicles TVehicleEntryArray

New list of vehicles.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehiclesSet</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

VehicleRepositoryVehiclesClear

Deletes all vehicles stored in the session's vehicle repository.

<QUERY>
<MC_QUERY_NAME>VehicleRepositoryVehiclesClear</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>VehicleRepositoryVehiclesClear</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.

SearchGetParamValue

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

<QUERY>
<MC_QUERY_NAME>SearchGetParamValue</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ParamName>WideString</ParamName>
</QUERY>

SessionID

Session identifier.

ParamName

Parameter name.


<ANSWER>
<MC_ANSWER_NAME>SearchGetParamValue</MC_ANSWER_NAME>
<ParamValue>WideString</ParamValue>
<Result>Integer</Result>
</ANSWER>

ParamValue

Parameter value.

Result

Returns value from error code table.

SearchGetParamValues

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

<QUERY>
<MC_QUERY_NAME>SearchGetParamValues</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
</QUERY>

SessionID

Session identifier.


<ANSWER>
<MC_ANSWER_NAME>SearchGetParamValues</MC_ANSWER_NAME>
<ParamNames>
<ITEM>WideString</ITEM>
</ParamNames>
<ParamValues>
<ITEM>WideString</ITEM>
</ParamValues>
<Result>Integer</Result>
</ANSWER>

ParamNames TWideStringArray

Parameter names.

ParamValues TWideStringArray

Parameter values.

Result

Returns value from error code table.

SearchSetParamValue

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

<QUERY>
<MC_QUERY_NAME>SearchSetParamValue</MC_QUERY_NAME>
<SessionID>TSessionID</SessionID>
<ParamName>WideString</ParamName>
<ParamValue>WideString</ParamValue>
</QUERY>

SessionID

Session identifier.

ParamName

Parameter name.

ParamValue

Parameter value.


<ANSWER>
<MC_ANSWER_NAME>SearchSetParamValue</MC_ANSWER_NAME>
<Result>Integer</Result>
</ANSWER>

Result

Returns value from error code table.


TLongLatPoint

A geographic point based on the WGS84 coordinate system (datum).

<Longitude>Double</Longitude>
<Latitude>Double</Latitude>

Longitude

Longitude coordinate of the point. It is float value between -180 and 180. Negative values concern western hemisphere (W), positive - eastern (E).

Latitude

Latitude coordinate of the point. It is float value between -90 and 90. Negative values concern southern hemisphere (S), positive - northern (N).

TLongLatRect

A geographic rectangle described with two geographic points.

<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>

TopLeft TLongLatPoint

Top-left point of the rectangle.

BottomRight TLongLatPoint

Bottom-right point of the rectangle.

TFontParameters

A font parameters.

<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>

Name

Font name.

Size

A size of the font.

Color

Font color. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

Style

Font style. It is a bit vector - each bit deals with one font style feature:
- bold = 0x01
- italic = 0x02
- underline = 0x04
- strikeout = 0x08

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

TPoint
<X>Integer</X>
<Y>Integer</Y>

X
Y
TRect
<TopLeft>
<X>Integer</X>
<Y>Integer</Y>
</TopLeft>
<BottomRight>
<X>Integer</X>
<Y>Integer</Y>
</BottomRight>

TopLeft TPoint
BottomRight TPoint
TRectsArray

Array of TRect items.

<ITEM>
<TopLeft>
<X>Integer</X>
<Y>Integer</Y>
</TopLeft>
<BottomRight>
<X>Integer</X>
<Y>Integer</Y>
</BottomRight>
</ITEM>

ITEM

Item of TRect type.

TLongLatRectArray

Array of TLongLatRect items.

<ITEM>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</ITEM>

ITEM

Item of TLongLatRect type.

TWideStringArray

Array of WideString items.

<ITEM>WideString</ITEM>

ITEM

Item of WideString type.

TLongLatPointArray

Array of TLongLatPoint items.

<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>

ITEM

Item of TLongLatPoint type.

TLongLatPoint2DArray

Array of TLongLatPointArray items.

<ITEM>
<ITEM>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</ITEM>
</ITEM>

ITEM

Item of TLongLatPointArray type.

TPointsArray

Array of TPoint items.

<ITEM>
<X>Integer</X>
<Y>Integer</Y>
</ITEM>

ITEM

Item of TPoint type.

TCaptionPositionArray

Array of TCaptionPosition items.

<ITEM>TCaptionPosition</ITEM>

ITEM

Item of TCaptionPosition type.

TObjectPosition

Geographic data of an object.

<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>

LongLat TLongLatPoint

Geographic coordinates of an object.

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).

TObjectPositionArray

Array of TObjectPosition items.

<ITEM>
<LongLat>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</LongLat>
<Status>TGeocodeStatus</Status>
</ITEM>

ITEM

Item of TObjectPosition type.

TBooleanArray

Array of Boolean items.

<ITEM>Boolean</ITEM>

ITEM

Item of Boolean type.

TByteArray

Array of Byte items.

<ITEM>Byte</ITEM>

ITEM

Item of Byte type.

TIconProperties

Icon properties.

<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>

IconID

A unique icon identifier.

IconFormat

Format of the icon. Supported formats can be received using GetAvailableIconFormats function.

IsTransparent

Option of icon transparency.

TransparentColor

The color of the icon transparency. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

TIconPropertiesArray

Array of TIconProperties items.

<ITEM>
<IconID>Integer</IconID>
<IconFormat>WideString</IconFormat>
<IsTransparent>Boolean</IsTransparent>
<TransparentColor>Integer</TransparentColor>
</ITEM>

ITEM

Item of TIconProperties type.

TGroupSettings

Visual settings of an object group.

<GroupName>WideString</GroupName>
<IconVisible>Boolean</IconVisible>
<IconID>Integer</IconID>
<IconSize>Integer</IconSize>
<IconFillSign>Boolean</IconFillSign>
<IconColor>TColor</IconColor>
<IconBorderSize>Integer</IconBorderSize>
<IconBorderColor>TColor</IconBorderColor>
<IconZoomMin>Double</IconZoomMin>
<IconZoomMax>Double</IconZoomMax>
<NameVisible>Boolean</NameVisible>
<NameFont>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</NameFont>
<NameZoomMin>Double</NameZoomMin>
<NameZoomMax>Double</NameZoomMax>

GroupName

Name of object group.

IconVisible

Indicates whether the object icons are drawn on maps.

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.

IconSize

Radius (in pixels) of dynamically drawn object icon. It must be a positive value. The value is essential only when IconIndex equals 0.

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.

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.

IconBorderSize

Width (in pixels) of the icon border. It must be a nonnegative value. The value is essential only when IconIndex equals 0.

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.

IconZoomMin

Minimum zoom of object icon visibility being an altitude expressed in meters over sea level. It must be positive value.

IconZoomMax

Maximum zoom of object icon visibility being an altitude expressed in meters over sea level. It must be positive value.

NameVisible

Indicates whether the object names are drawn on maps.

NameFont TFontParameters

Parameters of object name font.

NameZoomMin

Minimum zoom of object name visibility being an altitude expressed in meters over sea level. It must be positive value.

NameZoomMax

Maximum zoom of object name visibility being an altitude expressed in meters over sea level. It must be positive value.

TGroupShapeSettings

Visual shape settings of an object group.

<ShapeVisible>Boolean</ShapeVisible>
<ShapeUnderMap>Boolean</ShapeUnderMap>
<ShapeFill>Boolean</ShapeFill>
<ShapeColor>TColor</ShapeColor>
<ShapeBorderSize>Integer</ShapeBorderSize>
<ShapeBorderColor>TColor</ShapeBorderColor>
<ShapeZoomMin>Double</ShapeZoomMin>
<ShapeZoomMax>Double</ShapeZoomMax>

ShapeVisible

Indicates whether the object shapes are drawn on maps.

ShapeUnderMap

Indicates whether the object shapes are drawn under maps as a background.

ShapeFill

Indicates whether to fill the interior the object shapes.

ShapeColor

The color of shape interiors. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

ShapeBorderSize

Width (in pixels) of the shape border. It must be a nonnegative value.

ShapeBorderColor

The color of shape borders. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).

ShapeZoomMin

Minimum zoom of object shape visibility being an altitude expressed in meters over sea level. It must be positive value.

ShapeZoomMax

Maximum zoom of object shape visibility being an altitude expressed in meters over sea level. It must be positive value.

TDynamicIntegerArray

Array of Integer items.

<ITEM>Integer</ITEM>

ITEM

Item of Integer type.

TBlobArray

Array of BLOB items.

<ITEM>BLOB</ITEM>

ITEM

Item of BLOB type.

TDegeocodeResultEntry

An information concerning a map element being a result of degeocoding.

<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>

Name

Map element name.

FoundPoint TLongLatPoint

Geographic coordinates of the middle point of the element.

FoundLength

Distance (in meters) between found map element and the degeocoded point.

TDegeocodeResult

Geographic information concerning a point on map.

<AreaName0>WideString</AreaName0>
<AreaName1>WideString</AreaName1>
<AreaName2>WideString</AreaName2>
<AreaName3>WideString</AreaName3>
<City>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</City>
<Zip>WideString</Zip>
<Road>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Road>
<InternationalRoad>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</InternationalRoad>
<Street>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Street>
<Natural>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Natural>

AreaName0

Country name.

AreaName1

The name of 2nd level administrative area, i.e. a county.

AreaName2

The name of 3rd level administrative area, i.e. a district.

AreaName3

The name of 4th level administrative area.

City TDegeocodeResultEntry

City information.

Zip

Postal code.

Road TDegeocodeResultEntry

Road information.

InternationalRoad TDegeocodeResultEntry

International road information.

Street TDegeocodeResultEntry

Street information.

Natural TDegeocodeResultEntry

Topographic object information.

TDegeocodeResultArray

Array of TDegeocodeResult items.

<ITEM>
<AreaName0>WideString</AreaName0>
<AreaName1>WideString</AreaName1>
<AreaName2>WideString</AreaName2>
<AreaName3>WideString</AreaName3>
<City>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</City>
<Zip>WideString</Zip>
<Road>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Road>
<InternationalRoad>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</InternationalRoad>
<Street>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Street>
<Natural>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</Natural>
</ITEM>

ITEM

Item of TDegeocodeResult type.

TDegeocodeCityElementResult

An information concerning a city being a result of degeocoding.

<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>

Name

City name.

FoundPoint TLongLatPoint

Geographic coordinates of the middle point of the city.

FoundLength

Distance (in meters) between found city and the degeocoded point.

TDegeocodeCityElementResultArray

Array of TDegeocodeCityElementResult items.

<ITEM>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>

ITEM

Item of TDegeocodeCityElementResult type.

TDegeocodeRoadElementResult

An information concerning a road being a result of degeocoding.

<Name>WideString</Name>
<IsDirectional>Boolean</IsDirectional>
<IsPassable>Boolean</IsPassable>
<TypeIndex>Integer</TypeIndex>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>

Name

Road name.

IsDirectional

This value is set to true if the road is one-direction road. Otherwise it is set to false.

IsPassable

This value is set to true if the road is passable. Otherwise it is set to false.

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

FoundPoint TLongLatPoint

Geographic coordinates of the middle point of the road.

FoundLength

Distance (in meters) between found road and the degeocoded point.

TDegeocodeRoadElementResultArray

Array of TDegeocodeRoadElementResult items.

<ITEM>
<Name>WideString</Name>
<IsDirectional>Boolean</IsDirectional>
<IsPassable>Boolean</IsPassable>
<TypeIndex>Integer</TypeIndex>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>

ITEM

Item of TDegeocodeRoadElementResult type.

TDegeocodeExResultEntry

An information concerning an element being a result of extended degeocoding.

<PointIndex>Integer</PointIndex>
<LayerName>WideString</LayerName>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>

PointIndex

An index within the array of degeocoded points which the entry is for, beginning with 0 for the first point.

LayerName

Layer name.

Name

Map element name.

FoundPoint TLongLatPoint

Geographic coordinates of the middle point of the element.

FoundLength

Distance (in meters) between found map element and the degeocoded point.

TDegeocodeExResultEntryArray

Array of TDegeocodeExResultEntry items.

<ITEM>
<PointIndex>Integer</PointIndex>
<LayerName>WideString</LayerName>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>

ITEM

Item of TDegeocodeExResultEntry type.

TDegeocodeAtPointResult

An information concerning a map element being a result of degeocoding.

<Category>WideString</Category>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>

Category

The category of the element: Forest, Park, Cemetery, River, Lake, Railstation, Building, Square, Estate, Quarter, Highway exit, Airport, Peak, Border crossing and others.

Name

Map element name.

FoundPoint TLongLatPoint

Geographic coordinates of the middle point of the element.

FoundLength

Distance (in meters) between found map element and the degeocoded point.

TDegeocodeAtPointResultArray

Array of TDegeocodeAtPointResult items.

<ITEM>
<Category>WideString</Category>
<Name>WideString</Name>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>

ITEM

Item of TDegeocodeAtPointResult type.

TDegeocodeAtPointDatabaseResult

An information concerning a non map object being a result of degeocoding.

<Category>WideString</Category>
<Name>WideString</Name>
<ID>Integer</ID>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>

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

Name

Object name or multiline description.

ID

Object identifier.

FoundPoint TLongLatPoint

Geographic coordinates of the middle point of the object.

FoundLength

Distance (in meters) between found object and the degeocoded point.

TDegeocodeAtPointDatabaseResultArray

Array of TDegeocodeAtPointDatabaseResult items.

<ITEM>
<Category>WideString</Category>
<Name>WideString</Name>
<ID>Integer</ID>
<FoundPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</FoundPoint>
<FoundLength>Double</FoundLength>
</ITEM>

TGeocodePointInfo

Address information.

<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>

Country

Country name.

County

The name of 2nd level administrative area, i.e. a county.

District

The name of 3rd level administrative area, i.e. a district.

City

City name.

Zip

Postal code.

Street

Street name.

StreetNumber

Number of building on the street.

TGeocodePointInfoArray

Array of TGeocodePointInfo items.

<ITEM>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
</ITEM>

ITEM

Item of TGeocodePointInfo type.

TGeocodePointInfoEx

Extended address information. City, street and administrative abbreviations (terminated with dot) are permitted.

<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<Commune>WideString</Commune>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>

Country

Country name.

County

The name of 2nd level administrative area, i.e. a county.

District

The name of 3rd level administrative area, i.e. a district.

Commune

The name of 4rd level administrative area, i.e. a commune.

City

City name.

Zip

Postal code.

Street

Street name.

StreetNumber

Number of building on the street.

TGeocodePointInfoExArray

Array of TGeocodePointInfoEx items.

<ITEM>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<Commune>WideString</Commune>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
</ITEM>

ITEM

Item of TGeocodePointInfoEx type.

TMultiGeocodePointInfoEx

Extended address information. City, street and administrative abbreviations (terminated with dot) are permitted.

<SourceIndex>Integer</SourceIndex>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<Commune>WideString</Commune>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
<GeocodeLevel>Byte</GeocodeLevel>
<Position>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</Position>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>

SourceIndex

An index within the array of geocoded addresses which the entry is for, beginning with 0 for the first address.

Country

Country name.

County

The name of 2nd level administrative area, i.e. a county.

District

The name of 3rd level administrative area, i.e. a district.

Commune

The name of 4rd level administrative area, i.e. a commune.

City

City name.

Zip

Postal code.

Street

Street name.

StreetNumber

Number of building on the street.

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).

Position TLongLatPoint

A list of resultant geographic coordinates.

BoundingRect TLongLatRect

Geographic coordinates of the rectangles bounding objects found.

TMultiGeocodePointInfoExArray

Array of TMultiGeocodePointInfoEx items.

<ITEM>
<SourceIndex>Integer</SourceIndex>
<Country>WideString</Country>
<County>WideString</County>
<District>WideString</District>
<Commune>WideString</Commune>
<City>WideString</City>
<Zip>WideString</Zip>
<Street>WideString</Street>
<StreetNumber>WideString</StreetNumber>
<GeocodeLevel>Byte</GeocodeLevel>
<Position>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</Position>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
</ITEM>

ITEM

Item of TMultiGeocodePointInfoEx type.

TDynamicByteArray

Array of Byte items.

<ITEM>Byte</ITEM>

ITEM

Item of Byte type.

TTiledMapParams

Parameters used while tiled map image creation.

<Antialiasing>Boolean</Antialiasing>

Antialiasing

Option of antialiasing (smoothing) elements of the map image.

TImageRenderParams

Parameters used while map image creation.

<RenderWithoutSessionObjects>Boolean</RenderWithoutSessionObjects>
<DPI>Integer</DPI>
<Antialiasing>Boolean</Antialiasing>
<RenderParams>WideString</RenderParams>

RenderWithoutSessionObjects

Option of putting on a map additional session elements, such as search selections, database objects, etc.

DPI

Resulution of the map image expressed in dots per inch. It must be positive value.

Antialiasing

Option of antialiasing (smoothing) elements of the map image.

RenderParams

Other parameters (for future use).

TFloatArray

Array of Double items.

<ITEM>Double</ITEM>

ITEM

Item of Double type.

TMapFileEntry

Properties of map file loaded by server.

<Filename>WideString</Filename>
<Activated>Boolean</Activated>
<FileRegion>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</FileRegion>

Filename

Name of the file.

Activated

Map file activity

FileRegion TLongLatRect

Geographic coordinates of rectangle bounding the map file data.

TMapFileEntryArray

Array of TMapFileEntry items.

<ITEM>
<Filename>WideString</Filename>
<Activated>Boolean</Activated>
<FileRegion>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</FileRegion>
</ITEM>

ITEM

Item of TMapFileEntry type.

TFloatArrayArray

Array of TFloatArray items.

<ITEM>
<ITEM>Double</ITEM>
</ITEM>

ITEM

Item of TFloatArray type.

TWideStringArrayArray

Array of TWideStringArray items.

<ITEM>
<ITEM>WideString</ITEM>
</ITEM>

ITEM

Item of TWideStringArray type.

TBooleanArrayArray

Array of TBooleanArray items.

<ITEM>
<ITEM>Boolean</ITEM>
</ITEM>

ITEM

Item of TBooleanArray type.

TLocalizeObjectPositionData

Properties of a localized object position.

<PositionPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</PositionPoint>
<Time>Double</Time>
<Description>WideString</Description>
<ShowDescription>Boolean</ShowDescription>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<Font>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</Font>

PositionPoint TLongLatPoint

Geographic coordinates of the position point.

Time

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

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.

ShowDescription

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

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).

IconID

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

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).

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).

Font TFontParameters

A font of position description displayed on maps.

TLocalizeObjectPositionDataArray

Array of TLocalizeObjectPositionData items.

<ITEM>
<PositionPoint>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</PositionPoint>
<Time>Double</Time>
<Description>WideString</Description>
<ShowDescription>Boolean</ShowDescription>
<ShowName>Boolean</ShowName>
<IconID>Integer</IconID>
<ShowIcon>Boolean</ShowIcon>
<IconColor>Integer</IconColor>
<Font>
<Name>WideString</Name>
<Size>Integer</Size>
<Color>TColor</Color>
<Style>Integer</Style>
<Charset>Integer</Charset>
</Font>
</ITEM>

ITEM

Item of TLocalizeObjectPositionData type.

TSessionEnumEntry

Properties of a server session.

<SessionID>WideString</SessionID>
<SessionIP>WideString</SessionIP>
<SessionCreateTime>Double</SessionCreateTime>
<SessionAccessTime>Double</SessionAccessTime>
<SessionAccessTimes>Integer</SessionAccessTimes>
<SessionUserName>WideString</SessionUserName>
<SessionComment>WideString</SessionComment>

SessionID

Session identifier.

SessionIP

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

SessionCreateTime

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

SessionAccessTime

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

SessionAccessTimes

Number of queries requested by session.

SessionUserName

Name of user assigned to session.

SessionComment

Session comment.

TSessionEnumArray

Array of TSessionEnumEntry items.

<ITEM>
<SessionID>WideString</SessionID>
<SessionIP>WideString</SessionIP>
<SessionCreateTime>Double</SessionCreateTime>
<SessionAccessTime>Double</SessionAccessTime>
<SessionAccessTimes>Integer</SessionAccessTimes>
<SessionUserName>WideString</SessionUserName>
<SessionComment>WideString</SessionComment>
</ITEM>

ITEM

Item of TSessionEnumEntry type.

TViewConfigEntry

Properties of view config file loaded by server.

<ConfigName>WideString</ConfigName>
<Filename>WideString</Filename>

ConfigName

View config name.

Filename

Name of the file.

TViewConfigListArray

Array of TViewConfigEntry items.

<ITEM>
<ConfigName>WideString</ConfigName>
<Filename>WideString</Filename>
</ITEM>

ITEM

Item of TViewConfigEntry type.

TRepositoryRoute

Properties of route stored in the route repository.

<Ident>Integer</Ident>
<Description>WideString</Description>
<Color>TColor</Color>
<Visible>Boolean</Visible>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>

Ident

Identifier.

Description

Description.

Color

Route color.

Visible

Indicates whether to display a route on maps or not.

TotalRouteLength

Total route length in meters.

TotalRouteTime

Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TotalRouteCost

Total route cost.

TotalFuelCost

Total fuel cost.

TollRoadLength

Total length of toll route sectors.

TollRoadTime

Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.

AdditionalRouteCost

Additional costs of a route, i.e. cost of route impediments.

BoundingRect TLongLatRect

Geographic coordinates of the rectangle bounding the route area.

TRepositoryRouteArray

Array of TRepositoryRoute items.

<ITEM>
<Ident>Integer</Ident>
<Description>WideString</Description>
<Color>TColor</Color>
<Visible>Boolean</Visible>
<TotalRouteLength>Double</TotalRouteLength>
<TotalRouteTime>Double</TotalRouteTime>
<TotalRouteCost>Double</TotalRouteCost>
<TotalFuelCost>Double</TotalFuelCost>
<TollRoadLength>Double</TollRoadLength>
<TollRoadTime>Double</TollRoadTime>
<AdditionalRouteCost>Double</AdditionalRouteCost>
<BoundingRect>
<TopLeft>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</TopLeft>
<BottomRight>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</BottomRight>
</BoundingRect>
</ITEM>

ITEM

Item of TRepositoryRoute type.

TRouteAttributeParams

Properties of routing difficulty.

<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>

AttributeID

Difficulty unique identifier.

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

AttributeName

Difficulty name.

AttributeDescription

Difficulty description.

Closed

Option of blocking routing through the difficulty.

TwoDirectionalTraffic

Option of enabling two directional traffic through the difficulty.

MaxSpeed

Maximum speed allowed while routing through the difficulty (in km/h).

MaxWeight

Maximum vehicle weight allowed while routing through the difficulty (in tons).

MaxWidth

Maximum vehicle widht allowed while routing through the difficulty (in meters).

MaxHeight

Maximum vehicle height allowed while routing through the difficulty (in meters).

AdditonalCost

Cost of passing through the difficulty.

AdditionalTime

Time of passing through the difficulty, when value 1 means 1 day, 0.5 means 12 hours and so on.

BeginTime

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

EndTime

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

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.

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.

TRouteAttributeParamsArray

Array of TRouteAttributeParams items.

<ITEM>
<AttributeID>Integer</AttributeID>
<VehicleFilter>Integer</VehicleFilter>
<AttributeName>WideString</AttributeName>
<AttributeDescription>WideString</AttributeDescription>
<Closed>Boolean</Closed>
<TwoDirectionalTraffic>Boolean</TwoDirectionalTraffic>
<MaxSpeed>Integer</MaxSpeed>
<MaxWeight>Double</MaxWeight>
<MaxWidth>Double</MaxWidth>
<MaxHeight>Double</MaxHeight>
<AdditonalCost>Double</AdditonalCost>
<AdditionalTime>Double</AdditionalTime>
<BeginTime>Double</BeginTime>
<EndTime>Double</EndTime>
<BeginDayTime>Double</BeginDayTime>
<EndDayTime>Double</EndDayTime>
</ITEM>

ITEM

Item of TRouteAttributeParams type.

TRouteAttributePassedElem

Properties of the routing difficulty collected while route calculation analyzing.

<SubscriberName>WideString</SubscriberName>
<AttributeID>Integer</AttributeID>
<MiddlePosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePosition>
<BlockReasonBits>Integer</BlockReasonBits>

SubscriberName

Name of the difficulty provider.

AttributeID

Difficulty unique identifier.

MiddlePosition TLongLatPoint

Geographical coordinates of the difficulty.

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

TRouteAttributePassedArray

Array of TRouteAttributePassedElem items.

<ITEM>
<SubscriberName>WideString</SubscriberName>
<AttributeID>Integer</AttributeID>
<MiddlePosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</MiddlePosition>
<BlockReasonBits>Integer</BlockReasonBits>
</ITEM>

ITEM

Item of TRouteAttributePassedElem type.

TDriveThrough

Waypoint properties.

<EntryIndex>Integer</EntryIndex>
<SetAsDriveThrough>Boolean</SetAsDriveThrough>
<Radius>Double</Radius>

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.

SetAsDriveThrough

Option of setting the waypoint as a drive through waypoint.

Radius

Waypoint radius in meters (driving tollerance). It must be nonnegative value.

TDriveThroughArray

Array of TDriveThrough items.

<ITEM>
<EntryIndex>Integer</EntryIndex>
<SetAsDriveThrough>Boolean</SetAsDriveThrough>
<Radius>Double</Radius>
</ITEM>

ITEM

Item of TDriveThrough type.

TTimeWindow

Properties of the time window definiton.

<TimeFrom>Double</TimeFrom>
<TimeTo>Double</TimeTo>

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.

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.

TTimeWindowsArray

Array of TTimeWindow items.

<ITEM>
<TimeFrom>Double</TimeFrom>
<TimeTo>Double</TimeTo>
</ITEM>

ITEM

Item of TTimeWindow type.

TShipment

Properties of the shipment definition.

<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>

ShipmentID

Shipment identifier.

ShipmentType

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

ShipmentSize

Shipment size in m3.

ShipmentWeight

Shipment weight (in tons).

ShipmentLoadTime

Time of shipment loading (in minutes).

ShipmentUnloadTime

Time of shipment unloading (in minutes).

TShipmentsArray

Array of TShipment items.

<ITEM>
<ShipmentID>WideString</ShipmentID>
<ShipmentType>WideString</ShipmentType>
<ShipmentSize>Double</ShipmentSize>
<ShipmentWeight>Double</ShipmentWeight>
<ShipmentLoadTime>Integer</ShipmentLoadTime>
<ShipmentUnloadTime>Integer</ShipmentUnloadTime>
</ITEM>

ITEM

Item of TShipment type.

TRouteOptimalizationEntry

Properties of the waypoint entry for route optimization purposes.

<SourceEntryIndex>Integer</SourceEntryIndex>
<DestinationEntryIndex>Integer</DestinationEntryIndex>
<DroppedEntry>Boolean</DroppedEntry>
<DayAssigment>Integer</DayAssigment>
<DriverAssigment>Integer</DriverAssigment>

SourceEntryIndex

Original waypoint index before optimization process. The first waypoint has index 0, second has index 1 and so on.

DestinationEntryIndex

Result waypoint index after optimization process. The first waypoint has index 0, second has index 1 and so on.

DroppedEntry

For future use.

DayAssigment

For future use.

DriverAssigment

For future use.

TRouteOptimalizationEntryArray

Array of TRouteOptimalizationEntry items.

<ITEM>
<SourceEntryIndex>Integer</SourceEntryIndex>
<DestinationEntryIndex>Integer</DestinationEntryIndex>
<DroppedEntry>Boolean</DroppedEntry>
<DayAssigment>Integer</DayAssigment>
<DriverAssigment>Integer</DriverAssigment>
</ITEM>

ITEM

Item of TRouteOptimalizationEntry type.

TRouteOptimizerResultRoutesEntry

Properties of the optimized route.

<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<Cost>Integer</Cost>
<VehicleCategory>WideString</VehicleCategory>

TimingBegin

Time shift of route beginning (in minutes).

TimingEnd

Time shift of route end (in minutes).

Cost

Total route cost in hundreth parts of the main currency.

VehicleCategory

Category of vehicle for the route.

TRouteOptimizerResultRoutesArray

Array of TRouteOptimizerResultRoutesEntry items.

<ITEM>
<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<Cost>Integer</Cost>
<VehicleCategory>WideString</VehicleCategory>
</ITEM>

TRouteOptimizerEntry2

Properties of the optimized route segment.

<ResultRouteInfoIndex>Integer</ResultRouteInfoIndex>
<EntryIndex>Integer</EntryIndex>
<Duration>Integer</Duration>
<Arrival>Integer</Arrival>
<Wait>Integer</Wait>
<ShortBreak>Integer</ShortBreak>

ResultRouteInfoIndex

Index of the route within the list of optimized routes, beginning with 0 for the first route.

EntryIndex
Duration

Time duration of the segment (in minutes).

Arrival

Arrival time shift for the stop waypoint of the segment (in minutes).

Wait

Time to wait after arrival to the stop waypoint of the segment (in minutes).

ShortBreak

Break time occured within the segment, which is necessary after contigous driving without a break (in minutes).

TRouteOptimizerEntry2Array

Array of TRouteOptimizerEntry2 items.

<ITEM>
<ResultRouteInfoIndex>Integer</ResultRouteInfoIndex>
<EntryIndex>Integer</EntryIndex>
<Duration>Integer</Duration>
<Arrival>Integer</Arrival>
<Wait>Integer</Wait>
<ShortBreak>Integer</ShortBreak>
</ITEM>

ITEM

Item of TRouteOptimizerEntry2 type.

TRouteOptimizerEntryAction2

Properties of a single shipment action.

<EntryIndex>Integer</EntryIndex>
<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<ShipmentId>WideString</ShipmentId>
<Pickup>Boolean</Pickup>

EntryIndex
TimingBegin

Time shift of the beginning of the action (in minutes).

TimingEnd

Time shift of the end of the action (in minutes).

ShipmentId

Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by EntryIndex.

Pickup
TRouteOptimizerEntryAction2Array

Array of TRouteOptimizerEntryAction2 items.

<ITEM>
<EntryIndex>Integer</EntryIndex>
<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<ShipmentId>WideString</ShipmentId>
<Pickup>Boolean</Pickup>
</ITEM>

ITEM

Item of TRouteOptimizerEntryAction2 type.

TRouteOptimizerShipmentMove

Properties of the optimizer shipment event.

<ResultRouteInfoIndex>Integer</ResultRouteInfoIndex>
<ShipmentId>WideString</ShipmentId>
<PickupEntryIndex>Integer</PickupEntryIndex>
<DeliveryEntryIndex>Integer</DeliveryEntryIndex>
<LoadCapacitySize>Integer</LoadCapacitySize>
<LoadCapacityWeight>Integer</LoadCapacityWeight>

ResultRouteInfoIndex

Index of the route within the list of optimized routes, beginning with 0 for the first route.

ShipmentId

Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by PickupEntryIndex or DeliverEntryIndex.

PickupEntryIndex

Waypoint index of pickup shipment, beginning with 0 for the first waypoint.

DeliveryEntryIndex

Waypoint index of delivery shipment, beginning with 0 for the first waypoint.

LoadCapacitySize

Size of the shipment (in dm3).

LoadCapacityWeight

Weight of the shipment (in kilograms).

TRouteOptimizerShipmentMovesArray

Array of TRouteOptimizerShipmentMove items.

<ITEM>
<ResultRouteInfoIndex>Integer</ResultRouteInfoIndex>
<ShipmentId>WideString</ShipmentId>
<PickupEntryIndex>Integer</PickupEntryIndex>
<DeliveryEntryIndex>Integer</DeliveryEntryIndex>
<LoadCapacitySize>Integer</LoadCapacitySize>
<LoadCapacityWeight>Integer</LoadCapacityWeight>
</ITEM>

ITEM

Item of TRouteOptimizerShipmentMove type.

TRouteOptimizerEntry

Properties of the optimized route segment.

<ResultRouteInfoIndex>Integer</ResultRouteInfoIndex>
<FromEntryIndex>Integer</FromEntryIndex>
<ToEntryIndex>Integer</ToEntryIndex>
<Duration>Integer</Duration>
<Arrival>Integer</Arrival>
<Wait>Integer</Wait>
<ShortBreak>Integer</ShortBreak>

ResultRouteInfoIndex

Index of the route within the list of optimized routes, beginning with 0 for the first route.

FromEntryIndex

Start waypoint index for the segment.

ToEntryIndex

Stop waypoint index for the segment.

Duration

Time duration of the segment (in minutes).

Arrival

Arrival time shift for the stop waypoint of the segment (in minutes).

Wait

Time to wait after arrival to the stop waypoint of the segment (in minutes).

ShortBreak

Break time occured within the segment, which is necessary after contigous driving without a break (in minutes).

TRouteOptimizerEntryArray

Array of TRouteOptimizerEntry items.

<ITEM>
<ResultRouteInfoIndex>Integer</ResultRouteInfoIndex>
<FromEntryIndex>Integer</FromEntryIndex>
<ToEntryIndex>Integer</ToEntryIndex>
<Duration>Integer</Duration>
<Arrival>Integer</Arrival>
<Wait>Integer</Wait>
<ShortBreak>Integer</ShortBreak>
</ITEM>

ITEM

Item of TRouteOptimizerEntry type.

TRouteOptimizerShipmentAction

Properties of a single shipment action.

<EntryIndex>Integer</EntryIndex>
<IsFromEntry>Boolean</IsFromEntry>
<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<ShipmentId>WideString</ShipmentId>

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.

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).

TimingBegin

Time shift of the beginning of the action (in minutes).

TimingEnd

Time shift of the end of the action (in minutes).

ShipmentId

Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by EntryIndex.

TRouteOptimizerShipmentActionArray

Array of TRouteOptimizerShipmentAction items.

<ITEM>
<EntryIndex>Integer</EntryIndex>
<IsFromEntry>Boolean</IsFromEntry>
<TimingBegin>Integer</TimingBegin>
<TimingEnd>Integer</TimingEnd>
<ShipmentId>WideString</ShipmentId>
</ITEM>

TRouteItinerary

Route itinerary entry parameters.

<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>

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

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.

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.

EntryPosition TLongLatPoint

Entry position geographic coordinates.

EntryDistance

Current route distance from a route start point.

EntryTime

Current route time, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

EntryCost

Current route cost.

TRouteItineraryArray

Array of TRouteItinerary items.

<ITEM>
<ItineraryType>Integer</ItineraryType>
<ItineraryName0>WideString</ItineraryName0>
<ItineraryName1>WideString</ItineraryName1>
<EntryPosition>
<Longitude>Double</Longitude>
<Latitude>Double</Latitude>
</EntryPosition>
<EntryDistance>Double</EntryDistance>
<EntryTime>Double</EntryTime>
<EntryCost>Double</EntryCost>
</ITEM>

ITEM

Item of TRouteItinerary type.

TVehicleParams

Vehicle parameters.

<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>

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

IgnoreFuel

Option of taking fuel combustion into account while route calculating.

FixedCost

Fixed route cost. It must be nonnegative float value.

CostPerKilometer

Cost of 1 kilometer long route sector passed by the vehicle. It must be nonnegative float value.

CostPerHour

Cost of 1 hour route duration passed by the vehicle. It must be nonnegative float value.

TollRoadPerKilometer

Cost of 1 kilometer long toll-road.

TankCapacity

Vehicle tank capacity in litres. It must be nonnegative float value.

FuelCost

Cost of one fuel unit. It must be nonnegative float value.

RefuelTime

Refuel time, when value 1 means 1 day, 0.5 means 12 hours and so on.

VehicleWeight

Vehicle weight in tons. Ignored if 0.

VehicleLength

Vehicle length in meters. Ignored if 0.

VehicleHeight

Vehicle height in meters. Ignored if 0.

VehicleWidth

Vehicle width in meters. Ignored if 0.

VehicleCapacity

Vehicle capacity in m3. It must be nonnegative float value.

VehicleLoadCapacity

Vehicle load capacity in tons. It must be nonnegative float value.

ShippingTime

Ferry shipping time, when value 1 means 1 day, 0.5 means 12 hours and so on.

BorderPassTime

Border pass time, when value 1 means 1 day, 0.5 means 12 hours and so on.

TDriverParams

Driver parameters.

<JourneyStartTime>Double</JourneyStartTime>
<DayWorkTime>Double</DayWorkTime>
<ContinuousWorkTime>Double</ContinuousWorkTime>
<BreakTime>Double</BreakTime>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>

JourneyStartTime

Work start time, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.

DayWorkTime

Day work time, when value 1 means 1 day, 0.5 means 12 hours and so on.

ContinuousWorkTime

Continuous work time, when value 1 means 1 day, 0.5 means 12 hours and so on.

BreakTime

Break time, when value 1 means 1 day, 0.5 means 12 hours and so on.

CostPerKilometer

Cost of 1 kilometer long route sector passed by the driver. It must be nonnegative float value.

CostPerHour

Cost of 1 hour route duration passed by the driver. It must be nonnegative float value.

TRoadParams

Road parameters.

<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>

RoadType

Road type. Supported types can be received using GetAvailableRoadTypes function.

Use

Option of using roads of the type while route calculating.

Speed

Maximum speed permitted on roads of the type (in km/h). It must be nonnegative value.

Combustion

Fuel combustion on road of the type (in l/100km). It must be nonnegative value.

TRoadParamsArray

Array of TRoadParams items.

<ITEM>
<RoadType>WideString</RoadType>
<Use>Boolean</Use>
<Speed>Double</Speed>
<Combustion>Double</Combustion>
</ITEM>

ITEM

Item of TRoadParams type.

TRoadViaTollParams

viaTOLL parameters.

<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>

RoadType

Road type. Supported types can be received using GetAvailableRoadTypes function.

ViaTollCost

Cost per km.

TRoadViaTollParamsArray

Array of TRoadViaTollParams items.

<ITEM>
<RoadType>WideString</RoadType>
<ViaTollCost>Double</ViaTollCost>
</ITEM>

ITEM

Item of TRoadViaTollParams type.

TRoadResults

Summaric route results taking into account roads of one given type.

<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>

RoadType

Road type. Supported types can be received using GetAvailableRoadTypes function.

Length

Route length in meters.

Time

Route duration, when value 1 means 1 day, 0.5 means 12 hours and so on.

FuelCost

Fuel combustion cost.

VehicleKilometerCost

Vehicle kilometer cost.

VehicleHourCost

Vehicle time cost.

DriverKilometerCost

Driver kilometer cost.

DriverHourCost

Driver time cost.

TRoadResultsArray

Array of TRoadResults items.

<ITEM>
<RoadType>WideString</RoadType>
<Length>Double</Length>
<Time>Double</Time>
<FuelCost>Double</FuelCost>
<VehicleKilometerCost>Double</VehicleKilometerCost>
<VehicleHourCost>Double</VehicleHourCost>
<DriverKilometerCost>Double</DriverKilometerCost>
<DriverHourCost>Double</DriverHourCost>
</ITEM>

ITEM

Item of TRoadResults type.

TViaTollRoadResults

Summaric viaTOLL results taking into account roads of one given type.

<RoadType>WideString</RoadType>
<ViaTollLength>Double</ViaTollLength>
<ViaTollCost>Double</ViaTollCost>

RoadType

Road type. Supported types can be received using GetAvailableRoadTypes function.

ViaTollLength

Route length in meters.

ViaTollCost

viaTOLL cost.

TViaTollRoadResultsArray

Array of TViaTollRoadResults items.

<ITEM>
<RoadType>WideString</RoadType>
<ViaTollLength>Double</ViaTollLength>
<ViaTollCost>Double</ViaTollCost>
</ITEM>

ITEM

Item of TViaTollRoadResults type.

TLogisticTOLLResults

Summaric cost results of toll roads for the given country.

<CountryName>WideString</CountryName>
<EntryType>WideString</EntryType>
<PaymentCurrency>WideString</PaymentCurrency>
<PaymentOriginalCurrency>Double</PaymentOriginalCurrency>
<PaymentLocalCurrency>Double</PaymentLocalCurrency>
<VAT>Double</VAT>

CountryName

Name of the country.

EntryType

Toll type, e.g. Charge, Vignette.

PaymentCurrency

Official abbreviation for the original currency.

PaymentOriginalCurrency

Cost in the original currency.

PaymentLocalCurrency

Cost in the local currency set in the sever session.

VAT

Tax rate (in percents).

TLogisticTOLLResultsArray

Array of TLogisticTOLLResults items.

<ITEM>
<CountryName>WideString</CountryName>
<EntryType>WideString</EntryType>
<PaymentCurrency>WideString</PaymentCurrency>
<PaymentOriginalCurrency>Double</PaymentOriginalCurrency>
<PaymentLocalCurrency>Double</PaymentLocalCurrency>
<VAT>Double</VAT>
</ITEM>

ITEM

Item of TLogisticTOLLResults type.

TVehicleEntry

Vehicle parameters - TVehicleParams extended with name, external type, count of vehicles and weight per axle.

<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>

VehicleCategory

Vehicle category.

VehicleName

Vehicle name. For future use.

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

IgnoreFuel

Option of taking fuel combustion into account while route calculating.

FixedCost

Fixed route cost. It must be nonnegative float value.

CostPerKilometer

Cost of 1 kilometer long route sector passed by the vehicle. It must be nonnegative float value.

CostPerHour

Cost of 1 hour route duration passed by the vehicle. It must be nonnegative float value.

TollRoadPerKilometer

Cost of 1 kilometer long toll-road.

TankCapacity

Vehicle tank capacity in litres. It must be nonnegative float value.

FuelCost

Cost of one fuel unit. It must be nonnegative float value.

RefuelTime

Refuel time, when value 1 means 1 day, 0.5 means 12 hours and so on.

VehicleWeight

Vehicle weight in tons. Ignored if 0.

VehicleWeightPerAxle

Weight per axle in tons. Ignored if 0.

VehicleLength

Vehicle length in meters. Ignored if 0.

VehicleHeight

Vehicle height in meters. Ignored if 0.

VehicleWidth

Vehicle width in meters. Ignored if 0.

VehicleCapacity

Vehicle capacity in m3. It must be nonnegative float value.

VehicleLoadCapacity

Vehicle load capacity in tons. It must be nonnegative float value.

VehicleMaxCount

Maximal number of vehicles of this kind available.

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

ShippingTime

Ferry shipping time, when value 1 means 1 day, 0.5 means 12 hours and so on.

BorderPassTime

Border pass time, when value 1 means 1 day, 0.5 means 12 hours and so on.

VehicleLoadTime

Time of vehicle loading (in minutes).

VehicleUnloadTime

Time of vehicle unloading (in minutes).

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.

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.

VehicleMaxRouteDuration

Maximal duration of a single route (in minutes).

VehicleMaxCumulDrivingBeforeShortBreak

Maximal duration of a contigous driving without a break (in minutes).

VehicleMaxWaitingTime

Maximal time of waiting at a single route point (in minutes).

VehicleCanDoManyLoads

Option of multiple loadability. For future use.

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.

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.

TVehicleEntryArray

Array of TVehicleEntry items.

<ITEM>
<VehicleCategory>WideString</VehicleCategory>
<VehicleName>WideString</VehicleName>
<VehicleType>Integer</VehicleType>
<IgnoreFuel>Boolean</IgnoreFuel>
<FixedCost>Double</FixedCost>
<CostPerKilometer>Double</CostPerKilometer>
<CostPerHour>Double</CostPerHour>
<TollRoadPerKilometer>Double</TollRoadPerKilometer>
<TankCapacity>Double</TankCapacity>
<FuelCost>Double</FuelCost>
<RefuelTime>Double</RefuelTime>
<VehicleWeight>Double</VehicleWeight>
<VehicleWeightPerAxle>Double</VehicleWeightPerAxle>
<VehicleLength>Double</VehicleLength>
<VehicleHeight>Double</VehicleHeight>
<VehicleWidth>Double</VehicleWidth>
<VehicleCapacity>Double</VehicleCapacity>
<VehicleLoadCapacity>Double</VehicleLoadCapacity>
<VehicleMaxCount>Integer</VehicleMaxCount>
<VehicleLoadType>Integer</VehicleLoadType>
<ShippingTime>Double</ShippingTime>
<BorderPassTime>Double</BorderPassTime>
<VehicleLoadTime>Integer</VehicleLoadTime>
<VehicleUnloadTime>Integer</VehicleUnloadTime>
<VehicleAvailableFrom>Double</VehicleAvailableFrom>
<VehicleAvailableTo>Double</VehicleAvailableTo>
<VehicleMaxRouteDuration>Integer</VehicleMaxRouteDuration>
<VehicleMaxCumulDrivingBeforeShortBreak>Integer</VehicleMaxCumulDrivingBeforeShortBreak>
<VehicleMaxWaitingTime>Integer</VehicleMaxWaitingTime>
<VehicleCanDoManyLoads>Boolean</VehicleCanDoManyLoads>
<VehicleStartingLocationIndex>Integer</VehicleStartingLocationIndex>
<VehicleFinishingLocationIndex>Integer</VehicleFinishingLocationIndex>
</ITEM>

ITEM

Item of TVehicleEntry type.

TVehicleCategoryToShipmentTypeIncompatibility

A pair of vehilce category and shipment type.

<VehicleCategory>WideString</VehicleCategory>
<ShipmentType>WideString</ShipmentType>

VehicleCategory

Vehicle category.

ShipmentType

Shipment type.

TVehicleCategoryToShipmentTypeIncompatibilityArray

Array of TVehicleCategoryToShipmentTypeIncompatibility items.

<ITEM>
<VehicleCategory>WideString</VehicleCategory>
<ShipmentType>WideString</ShipmentType>
</ITEM>

TShipmentTypeToShipmentTypeIncompatibility

A pair of shipment types.

<ShipmentType1>WideString</ShipmentType1>
<ShipmentType2>WideString</ShipmentType2>

ShipmentType1

First shipment type.

ShipmentType2

Second shipment type.

TShipmentTypeToShipmentTypeIncompatibilityArray

Array of TShipmentTypeToShipmentTypeIncompatibility items.

<ITEM>
<ShipmentType1>WideString</ShipmentType1>
<ShipmentType2>WideString</ShipmentType2>
</ITEM>


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.