MapCenter Documentation 4.3.3.0
Application Programming Interface
Copyright (c) 2014 Emapa S.A.
Index
- Modules
- Functions
- Base module
- ActivateMapFile
- AdminDropSession
- AuthCreateGroup
- AuthCreateUser
- AuthDeleteGroup
- AuthDeleteUser
- AuthGetGroup
- AuthGetGroupsList
- AuthGetUserParamEx
- AuthGetUserParams
- AuthGetUsersList
- AuthModifyGroup
- AuthModifyUser
- AuthModifyUserPassword
- AuthSetUserParamEx
- CreateSessionID
- DeactivateMapFile
- DropSession
- GetActiveSessions
- GetAvailableMapFiles
- GetCurrentSessionCount
- GetCurrentViewConfig
- GetLoadedMapsRegion
- GetMapModules
- GetMaxSessionsCount
- GetServerVersion
- GetSessionComment
- GetSessionLanguageContext
- GetSessionLifetimeSeconds
- GetViewConfigList
- KeepSession
- LoadCurrentViewConfig
- ReloadMapFiles
- ServiceConfigGetServiceParams
- ServiceConfigSetServiceParam
- SetCurrentViewConfig
- SetSessionComment
- SetSessionLanguageContext
- Map module
- ConvertMapToScreen
- ConvertScreenToMap
- Degeocode
- DegeocodeAtPoint
- DegeocodeEx
- DegeocodeExWithAttributes
- DegeocodeGetParamValue
- DegeocodeSetParamValue
- ForwardCalc
- GetAvailableIconFormats
- GetAvailableImageFormats
- GetDefaultLayers
- GetDegeocodeLayers
- GetMapPointLength
- GetProjections
- GetScreenPointLength
- GetTiledMapLayers
- InverseCalc
- RenderMapOnHWNDByPoint
- RenderMapOnHWNDByPointWithCopyright
- RenderMapOnHWNDByRect
- RenderMapOnHWNDByRectWithCopyright
- RenderMapOnImageByPoint
- RenderMapOnImageByPointWithCopyright
- RenderMapOnImageByRect
- RenderMapOnImageByRectWithCopyright
- RenderSplitMapOnImageByPoint
- RenderSplitMapOnImageByPointWithCopyright
- RenderSplitMapOnImageByRect
- RenderSplitMapOnImageByRectWithCopyright
- RenderTiledMap
- RenderTiledMapEx
- RenderTiledMapWithCopyright
- Search module
- ClearMapSelection
- Geocode
- GeocodeEx
- MultiGeocodeEx
- SearchAddCityToSelection
- SearchAddObjectToSelection
- SearchAddStreetCrossingToSelection
- SearchAddStreetWithNumToSelection
- SearchGetCityList
- SearchGetCityListEx
- SearchGetCountryList
- SearchGetItemKindList
- SearchGetItemsList
- SearchGetParamValue
- SearchGetParamValues
- SearchGetStreetHandle
- SearchInitialize
- SearchSelectCities
- SearchSelectItems
- SearchSelectItemsEx
- SearchSetItemsFilter
- SearchSetParamValue
- Localize module
- LocalizeAddObjectPositions
- LocalizeGetObjectVisibility
- LocalizeIconAdd
- LocalizeIconClear
- LocalizeIconGet
- LocalizeIconGetCount
- LocalizeIconIDToItemIndex
- LocalizeIconRemove
- LocalizeIconSet
- LocalizeNumFieldsAdd
- LocalizeNumFieldsClear
- LocalizeNumFieldsGet
- LocalizeNumFieldsGetCount
- LocalizeNumFieldsRemove
- LocalizeNumFieldsSet
- LocalizeObjectAdd
- LocalizeObjectAddWithPositions
- LocalizeObjectClear
- LocalizeObjectEntityIDToItemIndex
- LocalizeObjectGet
- LocalizeObjectGetCount
- LocalizeObjectPositionAdd
- LocalizeObjectPositionClear
- LocalizeObjectPositionGet
- LocalizeObjectPositionGetCount
- LocalizeObjectPositionRemove
- LocalizeObjectPositionSet
- LocalizeObjectRemove
- LocalizeObjectSet
- LocalizeSetObjectVisibility
- LocalizeStrFieldsAdd
- LocalizeStrFieldsClear
- LocalizeStrFieldsGet
- LocalizeStrFieldsGetCount
- LocalizeStrFieldsRemove
- LocalizeStrFieldsSet
- Objects module
- AddGroupIcon
- AppendGroup
- AppendObject
- AppendObjectCircle
- AppendObjectEllipse
- AppendObjectPolygon
- AppendObjectPolyline
- AppendObjectRectangle
- AppendObjects
- CancelEditGroup
- CancelEditObject
- CancelEditObjectFields
- CheckUpdate
- ClearSetFilter
- CreateObjectSet
- DeleteGroup
- DeleteGroupIcon
- DeleteObject
- DeleteObjects
- DeleteObjectShape
- EditGroup
- EditObject
- EditObjectFields
- FilterByObjectShape
- FilterByPoint
- FilterByRadius
- FilterByShape
- FilterByText
- GetAggregatedObjects
- GetAggregatedObjectShapes
- GetDatabaseList
- GetDatabaseTableList
- GetGroupBinaryData
- GetGroupIcon
- GetGroupIcons
- GetGroupSettings
- GetGroupShapeSettings
- GetModifiedFields
- GetNextResult_FieldSet
- GetNextResult_IDSet
- GetNextResult_PositionSet
- GetNextResult_RemovedSet
- GetNextResult_Set
- GetNextResult_UpdatedSet
- GetObject
- GetObjectAggregates
- GetObjectBinaryData
- GetObjectCircles
- GetObjectCount
- GetObjectEllipses
- GetObjectFields
- GetObjectPolygons
- GetObjectPolylines
- GetObjectRectangles
- GetRemovedFields
- GetVisibleGroups
- MapBaseConnect
- MapBaseDisconnect
- MapBaseLoadFromBlob
- MapBaseStoreToBlob
- PostGroup
- PostObject
- PostObjects
- SetGroupBinaryData
- SetGroupShapeSettings
- SetObjectBinaryData
- SetObjectFields
- SetObjectIDs
- SetVisibleGroups
- RoutePlanner module
- RoutePlannerCalculatePointDistanceFromRoute
- RoutePlannerCalculatePointWithinRouteBuffer
- RoutePlannerCalculateRoute
- RoutePlannerCalculateRouteDistanceMatrix
- RoutePlannerCalculateRouteFromGPSTrack
- RoutePlannerCalculateRoutesWithMultipleDepots
- RoutePlannerCalculateRoutesWithSingleDepot
- RoutePlannerCalculateRouteWithBinaryResult
- RoutePlannerDriverParamsGet
- RoutePlannerDriverParamsSet
- RoutePlannerEntriesAdd
- RoutePlannerEntriesAddWithDescription
- RoutePlannerEntriesClear
- RoutePlannerEntriesGet
- RoutePlannerEntriesGetCount
- RoutePlannerEntriesGetWithSnapPoints
- RoutePlannerEntriesSet
- RoutePlannerEntriesSetAsDriveThrough
- RoutePlannerEntriesSetWithDescription
- RoutePlannerEntryAdd
- RoutePlannerEntryAddWithDescription
- RoutePlannerEntryComplexMove
- RoutePlannerEntryGet
- RoutePlannerEntryInsert
- RoutePlannerEntryInsertWithDescription
- RoutePlannerEntryMove
- RoutePlannerEntryRemove
- RoutePlannerEntryReverse
- RoutePlannerEntrySet
- RoutePlannerEntrySetWithDescription
- RoutePlannerGetAvailableRoadTypes
- RoutePlannerGetParamValue
- RoutePlannerGetParamValues
- RoutePlannerGetRouteItinerary
- RoutePlannerGetRouteLogisticTOLLSummary
- RoutePlannerGetRouteRepresentation
- RoutePlannerGetRouteRepresentationWithBinaryResult
- RoutePlannerGetRouteSummary
- RoutePlannerGetRouteViaTollSummary
- RoutePlannerRoadParamsGet
- RoutePlannerRoadParamsSet
- RoutePlannerRoadViaTollParamsGet
- RoutePlannerRoadViaTollParamsSet
- RoutePlannerRouteClear
- RoutePlannerRouteLoadFromBlob
- RoutePlannerRouteLoadFromDatabase
- RoutePlannerRouteStoreToBlob
- RoutePlannerRouteStoreToDatabase
- RoutePlannerSetParamValue
- RoutePlannerSimpleCalculateRoute
- RoutePlannerSimpleCalculateRoute2
- RoutePlannerSimpleCalculateRoute2WithBinaryResult
- RoutePlannerSimpleCalculateRoute3
- RoutePlannerSimpleCalculateRoute3WithBinaryResult
- RoutePlannerSimpleCalculateRouteWithBinaryResult
- RoutePlannerVehicleParamExGet
- RoutePlannerVehicleParamExSet
- RoutePlannerVehicleParamsExGet
- RoutePlannerVehicleParamsGet
- RoutePlannerVehicleParamsGet2
- RoutePlannerVehicleParamsSet
- RoutePlannerVehicleParamsSet2
- VehicleRepositoryAddVehicle
- VehicleRepositoryDriverParamsGet
- VehicleRepositoryDriverParamsSet
- VehicleRepositoryRemoveVehicle
- VehicleRepositoryRoadParamsGet
- VehicleRepositoryRoadParamsSet
- VehicleRepositoryVehicleFetch
- VehicleRepositoryVehicleGet
- VehicleRepositoryVehicleReplace
- VehicleRepositoryVehiclesClear
- VehicleRepositoryVehicleSet
- VehicleRepositoryVehiclesGet
- VehicleRepositoryVehiclesSet
- VehicleRepositoryVehicleViaTollGet
- VehicleRepositoryVehicleViaTollSet
- RouteRepository module
- RoutePlannerCalculateAlternativeRoutesAndStore
- RoutePlannerCalculateRoutesWithMultipleDepotsAndStore
- RoutePlannerCalculateRoutesWithSingleDepotAndStore
- RoutePlannerSimpleCalculateAlternativeRoutesAndStore
- RouteRepositoryAddRoute
- RouteRepositoryAddRouteWithIdent
- RouteRepositoryCalculatePointDistanceFromRoute
- RouteRepositoryClear
- RouteRepositoryFetchRoute
- RouteRepositoryFetchRouteWithIdent
- RouteRepositoryGetRouteItinerary
- RouteRepositoryGetRouteItineraryByIdent
- RouteRepositoryGetRouteRepresentation
- RouteRepositoryGetRouteRepresentationByIdent
- RouteRepositoryGetRoutes
- RouteRepositoryGetRoutesCount
- RouteRepositoryGetRouteSummary
- RouteRepositoryGetRouteSummaryByIdent
- RouteRepositoryLoadFromBlob
- RouteRepositoryRemove
- RouteRepositoryRemoveWithIdent
- RouteRepositoryReplaceRoute
- RouteRepositoryReplaceRouteWithIdent
- RouteRepositorySetRouteColor
- RouteRepositorySetRouteColorByIdent
- RouteRepositorySetRouteDescription
- RouteRepositorySetRouteDescriptionByIdent
- RouteRepositorySetRouteVisibility
- RouteRepositorySetRouteVisibilityByIdent
- RouteRepositoryStoreToBlob
- RouteAttributes module
- RouteAttributesAddAlongRouteAttribute
- RouteAttributesAddLineAttribute
- RouteAttributesAddPointAttribute
- RouteAttributesAddPolygonAttribute
- RouteAttributesClearRouteAttribute
- RouteAttributesDeleteRouteAttribute
- RouteAttributesExecuteDataProviderAction
- RouteAttributesGetAttributesProviderList
- RouteAttributesGetDataProviderActions
- RouteAttributesGetDataProviderParams
- RouteAttributesGetPassedAttributesList
- RouteAttributesGetRouteAttribute
- RouteAttributesGetRouteAttributes
- RouteAttributesGetRouteAttributeWithGeometry
- RouteAttributesGetSubscribedProvidersList
- RouteAttributesLoadFromBlob
- RouteAttributesModifyAlongRouteAttribute
- RouteAttributesModifyLineAttribute
- RouteAttributesModifyPointAttribute
- RouteAttributesModifyPolygonAttribute
- RouteAttributesSetDataProviderParam
- RouteAttributesSetRouteAttribute
- RouteAttributesStoreToBlob
- RouteAttributesSubscribeToDataProvider
- RouteAttributesUnsubscribeFromDataProvider
- RouteOptimizer module
- RouteOptimizerAddEntryDeliveryShipment
- RouteOptimizerAddEntryDeliveryShipments
- RouteOptimizerAddEntryPickupShipment
- RouteOptimizerAddEntryPickupShipments
- RouteOptimizerAddEntryTimeWindow
- RouteOptimizerAddEntryTimeWindows
- RouteOptimizerAddShipmentType
- RouteOptimizerClearEntryDeliveryShipments
- RouteOptimizerClearEntryPickupShipments
- RouteOptimizerClearEntryTimeWindows
- RouteOptimizerGetDepotEntry
- RouteOptimizerGetEntryDeliveryShipments
- RouteOptimizerGetEntryPickupShipments
- RouteOptimizerGetEntryShipmentDeliveryPickupTimes
- RouteOptimizerGetEntryTimeWindows
- RouteOptimizerOptimizeRoute
- RouteOptimizerRemoveShipmentType
- RouteOptimizerSetDepotEntry
- RouteOptimizerSetEntryDeliveryShipments
- RouteOptimizerSetEntryPickupShipments
- RouteOptimizerSetEntryShipmentDeliveryPickupTimes
- RouteOptimizerSetEntryTimeWindows
- RouteOptimizerShipmentTypesClear
- RouteOptimizerShipmentTypesGet
- RouteOptimizerShipmentTypesSet
- RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd
- RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear
- RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet
- RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet
- RouteOptimizerSimpleOptimizeRoute
- RouteOptimizerSolveProblem
- RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd
- RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear
- RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet
- RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet
- Types
- TUID
- TColor
- TSessionID
- TConnectionString
- TRecordID
- TGeocodeStatus
- TCaptionPosition
- TSoapTRectsArray
- TSoapTLongLatRectArray
- TWideStringArray
- TSoapTLongLatPointArray
- TSoapTLongLatPoint2DArray
- TSoapTPointsArray
- TCaptionPositionArray
- TSoapTObjectPositionArray
- TBooleanArray
- TByteArray
- TSoapTIconPropertiesArray
- TDynamicIntegerArray
- TBlobArray
- TSoapTDegeocodeResultArray
- TSoapTDegeocodeCityElementResultArray
- TSoapTDegeocodeRoadElementResultArray
- TSoapTDegeocodeExResultEntryArray
- TSoapTDegeocodeAtPointResultArray
- TSoapTDegeocodeAtPointDatabaseResultArray
- TSoapTGeocodePointInfoArray
- TSoapTGeocodePointInfoExArray
- TSoapTMultiGeocodePointInfoExArray
- TDynamicByteArray
- TFloatArray
- TSoapTMapFileEntryArray
- TSoapTFloatArrayArray
- TSoapTWideStringArrayArray
- TSoapTBooleanArrayArray
- TSoapTLocalizeObjectPositionDataArray
- TSoapTSessionEnumArray
- TSoapTViewConfigListArray
- TSoapTRepositoryRouteArray
- TSoapTRouteAttributeParamsArray
- TSoapTRouteAttributePassedArray
- TSoapTDriveThroughArray
- TSoapTTimeWindowsArray
- TSoapTShipmentsArray
- TSoapTRouteOptimalizationEntryArray
- TSoapTRouteOptimizerResultRoutesArray
- TSoapTRouteOptimizerEntry2Array
- TSoapTRouteOptimizerEntryAction2Array
- TSoapTRouteOptimizerShipmentMovesArray
- TSoapTRouteOptimizerEntryArray
- TSoapTRouteOptimizerShipmentActionArray
- TSoapTRouteItineraryArray
- TSoapTRoadParamsArray
- TSoapTRoadViaTollParamsArray
- TSoapTRoadResultsArray
- TSoapTViaTollRoadResultsArray
- TSoapTLogisticTOLLResultsArray
- TSoapTVehicleEntryArray
- TSoapTVehicleCategoryToShipmentTypeIncompatibilityArray
- TSoapTShipmentTypeToShipmentTypeIncompatibilityArray
- Classes
- TSoapTLongLatPoint
- TSoapTLongLatRect
- TSoapTFontParameters
- TSoapTPoint
- TSoapTRect
- TSoapTObjectPosition
- TSoapTIconProperties
- TSoapTGroupSettings
- TSoapTGroupShapeSettings
- TSoapTDegeocodeResultEntry
- TSoapTDegeocodeResult
- TSoapTDegeocodeCityElementResult
- TSoapTDegeocodeRoadElementResult
- TSoapTDegeocodeExResultEntry
- TSoapTDegeocodeAtPointResult
- TSoapTDegeocodeAtPointDatabaseResult
- TSoapTGeocodePointInfo
- TSoapTGeocodePointInfoEx
- TSoapTMultiGeocodePointInfoEx
- TSoapTTiledMapParams
- TSoapTImageRenderParams
- TSoapTMapFileEntry
- TSoapTLocalizeObjectPositionData
- TSoapTSessionEnumEntry
- TSoapTViewConfigEntry
- TSoapTRepositoryRoute
- TSoapTRouteAttributeParams
- TSoapTRouteAttributePassedElem
- TSoapTDriveThrough
- TSoapTTimeWindow
- TSoapTShipment
- TSoapTRouteOptimalizationEntry
- TSoapTRouteOptimizerResultRoutesEntry
- TSoapTRouteOptimizerEntry2
- TSoapTRouteOptimizerEntryAction2
- TSoapTRouteOptimizerShipmentMove
- TSoapTRouteOptimizerEntry
- TSoapTRouteOptimizerShipmentAction
- TSoapTRouteItinerary
- TSoapTVehicleParams
- TSoapTDriverParams
- TSoapTRoadParams
- TSoapTRoadViaTollParams
- TSoapTRoadResults
- TSoapTViaTollRoadResults
- TSoapTLogisticTOLLResults
- TSoapTVehicleEntry
- TSoapTVehicleCategoryToShipmentTypeIncompatibility
- TSoapTShipmentTypeToShipmentTypeIncompatibility
- TSoapCreateSessionID__mcsResult
- TSoapGetSessionComment__mcsResult
- TSoapGetSessionLanguageContext__mcsResult
- TSoapGetMapModules__mcsResult
- TSoapGetServerVersion__mcsResult
- TSoapGetMaxSessionsCount__mcsResult
- TSoapGetCurrentSessionCount__mcsResult
- TSoapGetSessionLifetimeSeconds__mcsResult
- TSoapGetActiveSessions__mcsResult
- TSoapGetProjections__mcsResult
- TSoapGetAvailableImageFormats__mcsResult
- TSoapGetDefaultLayers__mcsResult
- TSoapGetAvailableMapFiles__mcsResult
- TSoapGetLoadedMapsRegion__mcsResult
- TSoapGetViewConfigList__mcsResult
- TSoapGetCurrentViewConfig__mcsResult
- TSoapAuthGetUserParams__mcsResult
- TSoapAuthGetUserParamEx__mcsResult
- TSoapAuthGetUsersList__mcsResult
- TSoapAuthGetGroup__mcsResult
- TSoapAuthGetGroupsList__mcsResult
- TSoapServiceConfigGetServiceParams__mcsResult
- TSoapRenderMapOnImageByPoint__mcsResult
- TSoapRenderMapOnImageByRect__mcsResult
- TSoapRenderSplitMapOnImageByPoint__mcsResult
- TSoapRenderSplitMapOnImageByRect__mcsResult
- TSoapRenderMapOnHWNDByPoint__mcsResult
- TSoapRenderMapOnHWNDByRect__mcsResult
- TSoapRenderMapOnImageByPointWithCopyright__mcsResult
- TSoapRenderMapOnImageByRectWithCopyright__mcsResult
- TSoapRenderSplitMapOnImageByPointWithCopyright__mcsResult
- TSoapRenderSplitMapOnImageByRectWithCopyright__mcsResult
- TSoapRenderMapOnHWNDByPointWithCopyright__mcsResult
- TSoapRenderMapOnHWNDByRectWithCopyright__mcsResult
- TSoapRenderTiledMap__mcsResult
- TSoapRenderTiledMapWithCopyright__mcsResult
- TSoapRenderTiledMapEx__mcsResult
- TSoapGetTiledMapLayers__mcsResult
- TSoapConvertMapToScreen__mcsResult
- TSoapConvertScreenToMap__mcsResult
- TSoapGetMapPointLength__mcsResult
- TSoapGetScreenPointLength__mcsResult
- TSoapInverseCalc__mcsResult
- TSoapForwardCalc__mcsResult
- TSoapGetDegeocodeLayers__mcsResult
- TSoapDegeocodeGetParamValue__mcsResult
- TSoapDegeocode__mcsResult
- TSoapDegeocodeEx__mcsResult
- TSoapDegeocodeExWithAttributes__mcsResult
- TSoapDegeocodeAtPoint__mcsResult
- TSoapMapBaseConnect__mcsResult
- TSoapMapBaseStoreToBlob__mcsResult
- TSoapGetDatabaseList__mcsResult
- TSoapGetDatabaseTableList__mcsResult
- TSoapGetObjectCount__mcsResult
- TSoapGetObjectFields__mcsResult
- TSoapGetObject__mcsResult
- TSoapPostObjects__mcsResult
- TSoapAppendObject__mcsResult
- TSoapAppendObjects__mcsResult
- TSoapDeleteObjects__mcsResult
- TSoapGetObjectPolygons__mcsResult
- TSoapGetObjectPolylines__mcsResult
- TSoapGetObjectEllipses__mcsResult
- TSoapGetObjectRectangles__mcsResult
- TSoapGetObjectCircles__mcsResult
- TSoapGetObjectBinaryData__mcsResult
- TSoapGetGroupBinaryData__mcsResult
- TSoapGetGroupSettings__mcsResult
- TSoapGetGroupShapeSettings__mcsResult
- TSoapGetVisibleGroups__mcsResult
- TSoapAppendGroup__mcsResult
- TSoapGetGroupIcon__mcsResult
- TSoapAddGroupIcon__mcsResult
- TSoapGetGroupIcons__mcsResult
- TSoapCheckUpdate__mcsResult
- TSoapGetModifiedFields__mcsResult
- TSoapGetRemovedFields__mcsResult
- TSoapFilterByText__mcsResult
- TSoapFilterByPoint__mcsResult
- TSoapFilterByRadius__mcsResult
- TSoapFilterByObjectShape__mcsResult
- TSoapFilterByShape__mcsResult
- TSoapGetNextResult_FieldSet__mcsResult
- TSoapGetNextResult_IDSet__mcsResult
- TSoapGetNextResult_PositionSet__mcsResult
- TSoapGetNextResult_Set__mcsResult
- TSoapGetNextResult_UpdatedSet__mcsResult
- TSoapGetNextResult_RemovedSet__mcsResult
- TSoapGetObjectAggregates__mcsResult
- TSoapGetAggregatedObjectShapes__mcsResult
- TSoapGetAggregatedObjects__mcsResult
- TSoapSearchGetCountryList__mcsResult
- TSoapSearchSelectCities__mcsResult
- TSoapSearchGetCityList__mcsResult
- TSoapSearchGetCityListEx__mcsResult
- TSoapSearchGetItemKindList__mcsResult
- TSoapSearchSelectItems__mcsResult
- TSoapSearchSelectItemsEx__mcsResult
- TSoapSearchGetItemsList__mcsResult
- TSoapSearchAddCityToSelection__mcsResult
- TSoapSearchAddObjectToSelection__mcsResult
- TSoapSearchAddStreetWithNumToSelection__mcsResult
- TSoapSearchGetStreetHandle__mcsResult
- TSoapSearchAddStreetCrossingToSelection__mcsResult
- TSoapGeocode__mcsResult
- TSoapGeocodeEx__mcsResult
- TSoapMultiGeocodeEx__mcsResult
- TSoapLocalizeNumFieldsGet__mcsResult
- TSoapLocalizeNumFieldsGetCount__mcsResult
- TSoapLocalizeStrFieldsGet__mcsResult
- TSoapLocalizeStrFieldsGetCount__mcsResult
- TSoapLocalizeIconGet__mcsResult
- TSoapLocalizeIconGetCount__mcsResult
- TSoapLocalizeIconIDToItemIndex__mcsResult
- TSoapLocalizeObjectPositionGet__mcsResult
- TSoapLocalizeObjectPositionGetCount__mcsResult
- TSoapLocalizeObjectGet__mcsResult
- TSoapLocalizeObjectGetCount__mcsResult
- TSoapLocalizeObjectEntityIDToItemIndex__mcsResult
- TSoapLocalizeGetObjectVisibility__mcsResult
- TSoapGetAvailableIconFormats__mcsResult
- TSoapRoutePlannerGetAvailableRoadTypes__mcsResult
- TSoapRoutePlannerSimpleCalculateRoute__mcsResult
- TSoapRoutePlannerSimpleCalculateRoute2__mcsResult
- TSoapRoutePlannerSimpleCalculateRoute3__mcsResult
- TSoapRoutePlannerSimpleCalculateAlternativeRoutesAndStore__mcsResult
- TSoapRoutePlannerCalculateAlternativeRoutesAndStore__mcsResult
- TSoapRoutePlannerSimpleCalculateRouteWithBinaryResult__mcsResult
- TSoapRoutePlannerSimpleCalculateRoute2WithBinaryResult__mcsResult
- TSoapRoutePlannerSimpleCalculateRoute3WithBinaryResult__mcsResult
- TSoapRoutePlannerCalculateRoute__mcsResult
- TSoapRoutePlannerCalculateRouteWithBinaryResult__mcsResult
- TSoapRoutePlannerGetRouteItinerary__mcsResult
- TSoapRoutePlannerGetRouteRepresentation__mcsResult
- TSoapRoutePlannerGetRouteRepresentationWithBinaryResult__mcsResult
- TSoapRoutePlannerGetRouteSummary__mcsResult
- TSoapRoutePlannerGetRouteViaTollSummary__mcsResult
- TSoapRoutePlannerGetRouteLogisticTOLLSummary__mcsResult
- TSoapRoutePlannerEntriesSet__mcsResult
- TSoapRoutePlannerEntriesGet__mcsResult
- TSoapRoutePlannerEntriesGetWithSnapPoints__mcsResult
- TSoapRoutePlannerEntryAdd__mcsResult
- TSoapRoutePlannerEntriesAdd__mcsResult
- TSoapRoutePlannerEntryInsert__mcsResult
- TSoapRoutePlannerEntryGet__mcsResult
- TSoapRoutePlannerEntrySet__mcsResult
- TSoapRoutePlannerEntriesGetCount__mcsResult
- TSoapRoutePlannerCalculateRoutesWithSingleDepot__mcsResult
- TSoapRoutePlannerCalculateRoutesWithSingleDepotAndStore__mcsResult
- TSoapRoutePlannerCalculateRoutesWithMultipleDepots__mcsResult
- TSoapRoutePlannerCalculateRoutesWithMultipleDepotsAndStore__mcsResult
- TSoapRoutePlannerCalculateRouteDistanceMatrix__mcsResult
- TSoapRoutePlannerCalculatePointDistanceFromRoute__mcsResult
- TSoapRoutePlannerCalculatePointWithinRouteBuffer__mcsResult
- TSoapRoutePlannerCalculateRouteFromGPSTrack__mcsResult
- TSoapRoutePlannerVehicleParamsGet__mcsResult
- TSoapRoutePlannerVehicleParamsGet2__mcsResult
- TSoapRoutePlannerVehicleParamExGet__mcsResult
- TSoapRoutePlannerVehicleParamsExGet__mcsResult
- TSoapRoutePlannerDriverParamsGet__mcsResult
- TSoapRoutePlannerRoadParamsGet__mcsResult
- TSoapRoutePlannerRoadViaTollParamsGet__mcsResult
- TSoapRoutePlannerGetParamValue__mcsResult
- TSoapRoutePlannerGetParamValues__mcsResult
- TSoapRoutePlannerRouteStoreToBlob__mcsResult
- TSoapRouteRepositoryGetRoutesCount__mcsResult
- TSoapRouteRepositoryGetRoutes__mcsResult
- TSoapRouteRepositoryGetRouteItinerary__mcsResult
- TSoapRouteRepositoryGetRouteItineraryByIdent__mcsResult
- TSoapRouteRepositoryGetRouteRepresentation__mcsResult
- TSoapRouteRepositoryGetRouteRepresentationByIdent__mcsResult
- TSoapRouteRepositoryGetRouteSummary__mcsResult
- TSoapRouteRepositoryGetRouteSummaryByIdent__mcsResult
- TSoapRouteRepositoryStoreToBlob__mcsResult
- TSoapRouteRepositoryCalculatePointDistanceFromRoute__mcsResult
- TSoapRouteAttributesAddPointAttribute__mcsResult
- TSoapRouteAttributesAddLineAttribute__mcsResult
- TSoapRouteAttributesAddPolygonAttribute__mcsResult
- TSoapRouteAttributesAddAlongRouteAttribute__mcsResult
- TSoapRouteAttributesModifyAlongRouteAttribute__mcsResult
- TSoapRouteAttributesGetRouteAttribute__mcsResult
- TSoapRouteAttributesGetRouteAttributeWithGeometry__mcsResult
- TSoapRouteAttributesGetRouteAttributes__mcsResult
- TSoapRouteAttributesStoreToBlob__mcsResult
- TSoapRouteAttributesGetAttributesProviderList__mcsResult
- TSoapRouteAttributesGetSubscribedProvidersList__mcsResult
- TSoapRouteAttributesGetDataProviderParams__mcsResult
- TSoapRouteAttributesGetDataProviderActions__mcsResult
- TSoapRouteAttributesGetPassedAttributesList__mcsResult
- TSoapRouteOptimizerSimpleOptimizeRoute__mcsResult
- TSoapRouteOptimizerOptimizeRoute__mcsResult
- TSoapRouteOptimizerShipmentTypesGet__mcsResult
- TSoapRouteOptimizerGetDepotEntry__mcsResult
- TSoapRouteOptimizerGetEntryTimeWindows__mcsResult
- TSoapRouteOptimizerGetEntryDeliveryShipments__mcsResult
- TSoapRouteOptimizerGetEntryPickupShipments__mcsResult
- TSoapRouteOptimizerGetEntryShipmentDeliveryPickupTimes__mcsResult
- TSoapRouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet__mcsResult
- TSoapRouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet__mcsResult
- TSoapRouteOptimizerSolveProblem__mcsResult
- TSoapVehicleRepositoryVehicleGet__mcsResult
- TSoapVehicleRepositoryRoadParamsGet__mcsResult
- TSoapVehicleRepositoryVehicleViaTollGet__mcsResult
- TSoapVehicleRepositoryDriverParamsGet__mcsResult
- TSoapVehicleRepositoryVehiclesGet__mcsResult
- TSoapSearchGetParamValue__mcsResult
- TSoapSearchGetParamValues__mcsResult
- Errors
- OperationSuccessful (1)
- GeneralError (-1)
- FunctionUnimplemented (-2)
- SessionNotFound (-3)
- NonauthorizedAccess (-4)
- NotEnoughPermission (-5)
- SessionLimitExceeded (-10)
- UserSessionLimitExceeded (-11)
- WrongAuthentication (-13)
- ReferentialIntegrityError (-6)
- UniqueIndexViolation (-7)
- DataNotFound (-8)
- UpdateRequired (-9)
- DatabaseBlocked (-12)
- GeneralSearchError (-100)
- InvalidCountryIndex (-101)
- InvalidCityIndex (-102)
- InvalidCityCount (-103)
- InvalidItemKindIndex (-104)
- InvalidItemCount (-105)
- InvalidItemIndex (-106)
- StreetRequired (-107)
- SearchContextNotInitialized (-108)
- InvalidItemHandle (-109)
- NumerationNotFound (-110)
- CrossingNotFound (-111)
- GeneralLocalizeError (-200)
- InvalidLocalizeDataIndex (-201)
- InvalidIcon (-202)
- InvalidLocalizeEntityID (-203)
- InvalidNumericFieldsCount (-204)
- InvalidStringFieldsCount (-205)
- DuplicatedLocalizeEntityID (-206)
- InvalidIconMIMEType (-207)
- InvalidItemsCount (-208)
- InvalidIconData (-209)
- GeneralMapFileError (-300)
- MapFileNotFound (-301)
- MapFileAlreadyOpened (-302)
- MapFileAlreadyClosed (-303)
- WrongFileFormat (-304)
- GeneralRenderingError (-400)
- InvalidHDCHandle (-401)
- InvalidImageSize (-402)
- InvalidImageMIMEType (-403)
- WrongImageSize (-404)
- GeneralAuthorizationError (-500)
- UserAlreadyExists (-501)
- UserDoesNotExist (-502)
- UserGroupAlreadyExists (-503)
- UserGroupDoesNotExist (-504)
- UserGroupReadOnly (-505)
- GeneralRoutePlannerError (-600)
- WrongParamValue (-601)
- WrongParamName (-602)
- InvalidEntryIndex (-603)
- NotEnoughRouteEntries (-604)
- RouteNotFound (-605)
- DuplicatedEntryIndex (-606)
- RouteNotCalculated (-607)
- RouteIdentifierNotFound (-608)
- DuplicatedRoutingDifficultyIdentifier (-630)
- RoutingDifficultyIdentifierNotFound (-631)
- VehicleCategoryAlreadyExists (-660)
- DepotEntryNotSet (-661)
- DuplicatedShipmentIdentifier (-662)
BaseModule
MapCenter is a multiaccessible map server working in client-server architecture in compatibility with WebServices technology. Client applications communicate with the server by way of WebServices application programming interface using SOAP (Simple Object Access Protocol) and HTTP protocols. Specification of MapCenter's interface in WSDL (Web Services Description Language) format is available via [MapCenterURL:Port]/wsdl/IMapCenterService (Port is 6090 by default). For backward compatibility with older versions communication using XML files over HTTP protocol is supported at [MapCenterURL:Port]/xml?version=1.0 or simplier at [MapCenterURL:Port]. Functions supported by WebServices interface are also available in form of XML files at [MapCenterURL:Port]/xml?version=2.0 . All binary parameters (blobs) in functions supported by XML interface should be Base64 encoded and placed in CDATA section. The binary results of them are just like that encoded.
Communication with MapCenter can be optionally authorized (it is not by default and may be enabled using configaration tool). Standard HTTP authorization is used for it. MapCenter has its own user database. Users are grouped into user groups. One user belongs to one or more groups. At the installation MapCenter contains three users: admin (belonging to following groups: admins, dbadmins, dbeditors, mapviewers), user (dbeditors, mapviewers) and viewer (mapviewers). Each of the three default users has a the same password as his name. Lists of available users and groups can be obtained by AuthGetUsersList and AuthGetGroupsList functions. User database can be managed usig following functions: AuthCreateUser, AuthGetUserParams, AuthGetUserParamEx, AuthSetUserParamEx, AuthModifyUser, AuthModifyUserPassword, AuthDeleteUser, AuthCreateGroup, AuthGetGroup, AuthModifyGroup, AuthDeleteGroup. All the functions require MapCenter authorization enabled and can be invoked only by users belonging to admins group.
MapCenter server generates geographic informations based on vector maps in WGS84 coordinates system. Server offers map images and many additional informations concerned with them. MapCenter functionality is divided into modules. A list of modules available in the instance of server used can be obtained by GetMapModules function.
Each client application may set its own map settings and add its own informations onto maps by way of server sessions. At the beginning of communiction with MapCenter, an application should create such session using CreateSessionID function. Each user (if authorization is enabled) can create one or more sessions. Most of server API functions require the session identifier to be given. Sessions are kept alive by server for some time since last request - this time may be obtained using GetSessionLifetimeSeconds function. To lenghten session's live KeepSession function may be helpful. Early created session can be removed immediatelly by DropSession function. Maximum number of concurrently working sessions may be constrained by the MapCenter lincence - function GetMaxSessionsCount returns the limit. Other functions (GetCurrentSessionCount and GetActiveSessions) return data concerning active sessions - user from admins group can view all sessions, but other users see only their sessions. Admins can destroy any session using AdminDropSession function.
Base module of MapCenter server offers also functionality of loading and activating map files delivered (GetAvailableMapFiles, GetLoadedMapsRegion, ReloadMapFiles, ActivateMapFile, DeactivateMapFile). If MapCenter authorization is enabled, only users belonging to admins group can use these functions. Many maps can be processed simultaneously.
MapModule
Map module of MapCenter server offers functions for rendering maps as images (bitmaps or semi-vector files). Supported image formats are returned by GetAvailableImageFormats function, and available geographic projections by GetProjections function.
Single map images are generated by RenderMapOnImageByPoint or RenderMapOnImageByRect function. Map can be split into a matrix of images using RenderSplitMapOnImageByPoint or RenderSplitMapOnImageByRect function. For apllications installed on the same machine as MapCenter server more efficient are functions rendering maps on control canvas (HDC) directly - RenderMapOnHWNDByPoint or RenderMapOnHWNDByRect. RenderTiledMap function is optimized for web applications. It serves normalized maps with fixed zooms allowing efficient caching. All the functions are their twin functions which additionally return copyright clauses of supported map providers. There are functions with ...WithCopyright suffix.
Map module of MapCenter server offers also functionality of converting bitmap to geographic coordinates (ConvertScreenToMap) and vice versa (ConvertMapToScreen), calculating distances between points (GetMapPointLength, GetScreenPointLength, InverseCalc, ForwardCalc) and obtaining geographic informations concerning map points (Degeocode, DegeocodeEx, DegeocodeAtPoint).
SearchModule
Search module of MapCenter server offers functions for searching the maps and address geocoding. Currently searched data is kept into a server session within session search context. The context must be initialized by calling SearchInitialize function.
Map objects beeing searched are grouped into hierarchy - countries contain cities or final map items (roads, airports, rivers, etc.), cities contain final map items. Cities can be found using SearchSelectCities function returning the number of cities found. Required subset of values, stored in the session search context, is accessible by SearchGetCityList or SearchGetCityListEx function. Final map items can be found using SearchSelectItems (searching in cities) or SearchSelectItemsEx (searching in countries) function returning the number of items found. Required subset of values, stored in the session search context, is accessible by SearchGetItemsList function. Each map object may be marked out while map rendering. To add it to the session server context selection one should call one of following functions: SearchAddCityToSelection, SearchAddObjectToSelection, SearchAddStreetWithNumToSelection, SearchAddStreetCrossingToSelection.
Address geocoding is served by Geocode function which returns only one best result for each given address, and GeocodeEx or MultiGeocodeEx functions which return multiple proposals for one given address.
LocalizeModule
Localize module of MapCenter server offers functions for putting application objects equipped with geographic coordinates onto maps. Each localized object can contain many map positions (points) forming a path (track) or a set of single points. Each point (object position) can be marked out on rendered maps with icon or a circle. Currently localized data is kept into a server session.
All global configuration settings of localization are stored in three collections. List of required additional features of localized objects is divided into numeric fields collection and string fields collection; icons are stored in the third collection. The numeric fields collection is maintained with following functions: LocalizeNumFieldsAdd, LocalizeNumFieldsSet, LocalizeNumFieldsGet, LocalizeNumFieldsRemove, LocalizeNumFieldsClear, LocalizeNumFieldsGetCount. The string fields collection is maintained with following functions: LocalizeStrFieldsAdd, LocalizeStrFieldsSet, LocalizeStrFieldsGet, LocalizeStrFieldsRemove, LocalizeStrFieldsClear, LocalizeStrFieldsGetCount. The icons collection is maintained with following functions: LocalizeIconAdd, LocalizeIconSet, LocalizeIconGet, LocalizeIconRemove, LocalizeIconClear, LocalizeIconGetCount.
Collection of localized objects is maintained with functions: LocalizeObjectAdd, LocalizeObjectSet, LocalizeObjectGet, LocalizeObjectRemove, LocalizeObjectClear, LocalizeObjectGetCount. Adding at least one position for an object is necessary for showing the object on maps. Objects positions are maintained with following functions: LocalizeAddObjectPositions, LocalizeObjectPositionAdd, LocalizeObjectPositionSet, LocalizeObjectPositionGet, LocalizeObjectPositionRemove, LocalizeObjectPositionClear, LocalizeObjectPositionGetCount. It is possible to add to the server session an object together with its positions using one function (LocalizeObjectAddWithPositions). Putting a localized object onto maps while map image rendering can be enabled or disabled by LocalizeSetObjectVisibility function. Current visibility settings are accessible by LocalizeGetObjectVisibility function. Objects localized on maps are recognized by DegeocodeAtPoint function and some features of these objects are returned by the function.
ObjectsModule
Objects module of MapCenter server (MapBase) offers functions for connecting to a database and putting icons of records from the database (called objects) equipped with geographic coordinates onto maps, searching them using spatial queries and getting properties of them (object fields). Currently MapCenter suports only databases in its internal format (RSDB) - object sets accessible for MapCenter clients are stored as files in subfolder Rsdb and are of two types: Objects (*.emd files) and Logistics (*.eld files). Working with the functions of the module is possible only by authorized access which should be enabled using the configuration tool (disabled by default). Users from dbadmins group can create, restructure, edit and view databases, dbeditors edit and view data, and mapviewers can only view.
Accessible databases and their tables may be obtained using GetDatabaseList and GetDatabaseTableList functions. Server session can be connected to only one database of each type at the same time. Connection is realized by MapBaseConnect function. For closing the connection MapBaseDisconnect function should be used. Alternativelly there is possibility to load an ad hoc database directly from client application using MapBaseLoadFromBlob function and then to save changes as a file by MapBaseStoreToBlob function. New database can be created on server by CreateObjectSet function.
Record count in the object set is returned by GetObjectCount function. Objects are grouped into object groups, determining visual settings of contained objects. Each object can be placed on maps as a point and additionally can have got one or more spatial shapes assigned to it (polygons, polylines, rectangles, ellipese and circles). Any arbitrary binary data can be also assigned to an object. To obtain object set structure (field list, field feateures, object group list, object group icons) GetObjectFields function should be called. The structure of a database may be changed by function SetObjectFields call. Functions GetGroupSettings, GetGroupShapeSettings, GetGroupIcon and GetGroupIcons offer information on an object group visual settings. The modification of group settings is possible using following functions: EditGroup, PostGroup, AppendGroup, DeleteGroup, CancelEditGroup, AddGroupIcon, DeleteGroupIcon. Directly after object set openinig, all object groups are enabled (their objects are drawn on maps, unless object group settings limit icon visibility to some altitude range). The server session disables (or enables again) some object groups using GetVisibleGroups and SetVisibleGroups functions.
Data of objects can be downloaded from server in form of packages containing required number of objects (records) or in form of single object. The data can be get using following functions: GetNextResult_IDSet, GetNextResult_FieldSet, GetNextResult_PositionSet, GetNextResult_Set, GetObject, GetObjectPolygons, GetObjectPolylines, GetObjectRectangles, GetObjectEllipses, GetObjectCircles, GetObjectBinaryData. The modification of objects is possible using following functions: EditObject, PostObject, PostObjects, AppendObject, AppendObjects, DeleteObject, DeleteObjects, CancelEditObject, AppendObjectPolygon, AppendObjectPolyline, AppendObjectRectangle, AppendObjectEllipse, AppendObjectCircle, DeleteObjectShape, SetObjectBinaryData.
Statistic information about data changed by other parallel users can be received by functions: CheckUpdate, GetModifiedFields, GetRemovedFields, GetNextResult_UpdatedSet, GetNextResult_RemovedSet.
Some numerical and spatial aggregations for objects can be obtained using functions GetObjectAggregates, GetAggregatedObjects, GetAggregatedObjectShapes. Objects may be filtered by following functions: FilterByText, FilterByPoint, FilterByRadius, FilterByObjectShape, FilterByShape, SetObjectIDs. Each filter function works on data currently available in the object set - beeing the result of other previous filters. Filters can be disabled by ClearSetFilter function. Filters of currently opened object set are kept into a server session.
RoutePlannerModule
RoutePlanner module of MapCenter server offers functions for route calculating. Each server session stores a set of parameters taking into account while route calculating: vehicle parameters, driver parameters and road parameters. The parameters can be maintained by following functions: RoutePlannerVehicleParamsGet, RoutePlannerVehicleParamsSet, RoutePlannerVehicleParamsGet2, RoutePlannerVehicleParamsSet2, RoutePlannerDriverParamsGet, RoutePlannerDriverParamsSet, RoutePlannerRoadParamsGet, RoutePlannerRoadParamsSet, RoutePlannerRoadViaTollParamsGet, RoutePlannerRoadViaTollParamsSet. If not explicitly set, the parameters have some default values.
There is also possibility to store in the session more than one vehicle with its own independent parameters. The vehicle repository can be maintained by following functions: VehicleRepositoryAddVehicle, VehicleRepositoryRemoveVehicle, VehicleRepositoryVehicleGet, VehicleRepositoryVehicleSet, VehicleRepositoryVehiclesGet, VehicleRepositoryVehiclesSet, VehicleRepositoryVehiclesClear, VehicleRepositoryRoadParamsGet, VehicleRepositoryRoadParamsSet, VehicleRepositoryVehicleViaTollGet, VehicleRepositoryVehicleViaTollSet. Each vehicle can be fetched from the repository and set as a current session vehicle by VehicleRepositoryVehicleFetch function and replaced using session parameters by VehicleRepositoryVehicleReplace function.
Functions RoutePlannerCalculateRoute or RoutePlannerCalculateRouteWithBinaryResult calculate a route between at least two waypoints (route entries) stored in the sesssion. Calculated route can be removed from the session by RoutePlannerRouteClear function. A list of waypoints is maintained by following functions: RoutePlannerEntriesGet, RoutePlannerEntriesSet, RoutePlannerEntriesSetWithDescription, RoutePlannerEntryAdd, RoutePlannerEntryAddWithDescription, RoutePlannerEntryInsert, RoutePlannerEntryInsertWithDescription, RoutePlannerEntryMove, RoutePlannerEntryComplexMove, RoutePlannerEntryRemove, RoutePlannerEntrySet, RoutePlannerEntrySetWithDescription, RoutePlannerEntriesSetAsDriveThrough, RoutePlannerEntryReverse, RoutePlannerEntriesClear. After calculating the route can be stored in the session. Functions RoutePlannerGetRouteItinerary, RoutePlannerGetRouteRepresentation, RoutePlannerGetRouteRepresentationWithBinaryResult, RoutePlannerGetRouteSummary, RoutePlannerGetRouteViaTollSummary and RoutePlannerGetRouteLogisticTOLLSummary return features of currently stored in the session route.
Function RoutePlannerSimpleCalculateRoute calculates a route using its own parameters and waypoint list which optionally can replace session settings (alternatives are: RoutePlannerSimpleCalculateRouteWithBinaryResult, RoutePlannerSimpleCalculate2, RoutePlannerSimpleCalculateRoute2WithBinaryResult, RoutePlannerSimpleCalculate3, RoutePlannerSimpleCalculateRoute3WithBinaryResult). Function RoutePlannerCalculateRouteDistanceMatrix calculates a set of many routes between many waypoints as start and end points. Function RoutePlannerCalculateRouteFromGPSTrack calculates a route for a given list of waypoints given as a GPS track - it tries to recognize the real route based on the GPS track.
A list of waypoints and a route stored in the session are drawn on maps requested for the session. Visual parameters of routing data and routing options are maintained by functions RoutePlannerGetParamValue, RoutePlannerGetParamValues and RoutePlannerSetParamValue.
Functions RoutePlannerCalculatePointDistanceFromRoute and RoutePlannerCalculatePointWithinRouteBuffer operate on a route calculated and stored in the server session and calculate placement and distances for some given points near by the route.
Functions RoutePlannerCalculateRoutesWithSingleDepot and RoutePlannerCalculateRoutesWithMultipleDepots can calculate many routes at one time. The first function calculates a set of routes beginning with common start point (depot). Each destination point is taken as an end point for subsequent route. The second calculates a set of routes beginning with given start points (depots). Each destination point is taken as an end point for subsequent route beginning with the nearest start point.
RoutePlannerRouteStoreToBlob function generates binary dump of a route (together with route calculating parameters) stored in the server session which can be loaded later by RoutePlannerRouteLoadFromBlob function.
RouteRepositoryModule
RouteRepository module of MapCenter server offers functions for storing and presenting more than one route in the server session. The module augments functionality of RoutePlanner module. After route calculating, using one of RoutePlanner functions, one can add the route to the repository by RouteRepositoryAddRoute or RouteRepositoryAddRouteWithIdent function. Each route stored in the repository has some properties, i.e. identifier, color, visibility. Identifier is optional, color is set to green, and visibility to true, by default. Current paramaters of routes stored in the repository are available by RouteRepositoryGetRoutes function. The repository can be managed using following functions: RouteRepositoryReplaceRoute, RouteRepositoryReplaceRouteWithIdent, RouteRepositoryRemove, RouteRepositoryRemoveWithIdent, RouteRepositorySetRouteColor, RouteRepositorySetRouteColorByIdent, RouteRepositorySetRouteVisibility, RouteRepositorySetRouteVisibilityByIdent, RouteRepositorySetRouteDescription, RouteRepositorySetRouteDescriptionByIdent, RouteRepositoryClear. Each route can be fetched from repository and set as a current session route by RouteRepositoryFetchRoute or RouteRepositoryFetchRouteWithIdent function. Calculated results of each route are obtained by following functions: RouteRepositoryGetRouteItinerary, RouteRepositoryGetRouteItineraryByIdent, RouteRepositoryGetRouteRepresentation, RouteRepositoryGetRouteRepresentationByIdent, RouteRepositoryGetRouteSummary, RouteRepositoryGetRouteSummaryByIdent.
Functions RoutePlannerCalculateRoutesWithSingleDepotAndStore and RoutePlannerCalculateRoutesWithMultipleDepotsAndStore do the same as corresponding RoutePlannerCalculateRoutesWithSingleDepot and RoutePlannerCalculateRoutesWithMultipleDepots functions. In addition they can store calculated routes in the route repository. Function RouteRepositoryCalculatePointDistanceFromRoute calculates distances for some given points from all routes stored in the server session. Functions RoutePlannerSimpleCalculateAlternativeRoutesAndStore and RoutePlannerCalculateAlternativeRoutesAndStore calculate the optimal route and optionally at most two additional alternative routes. They also can store the resultant routes in the route repository.
RouteRepositoryStoreToBlob function generates binary dump of the whole repository which can be loaded later by RouteRepositoryLoadFromBlob function.
RouteAttributesModule
RouteAttributes module of MapCenter server offers functions for managing of routing difficulties in the server session beeing taken into account while route calculating. The module augments functionality of RoutePlanner module. Each routing difficulty has its geographic form dependent on its geometry kind (point, polyline, road-along placed polyline or polygon) and other properties, such as unique identifier (for management purposes) maximum speed, maximum vehicle height, additional passing through cost, etc. Difficulties can be add to the server session by RouteAttributesAddPointAttribute, RouteAttributesAddLineAttribute, RouteAttributesAddPolygonAttribute or RouteAttributesAddAlongRouteAttribute function. Current paramaters of routing difficulties stored in the session are available by RouteAttributesGetRouteAttributes, RouteAttributesGetRouteAttribute or RouteAttributesGetRouteAttributeWithGeometry function. Routing difficulties can be managed using following functions: RouteAttributesModifyPointAttribute, RouteAttributesModifyLineAttribute, RouteAttributesModifyPolygonAttribute, RouteAttributesModifyAlongRouteAttribute, RouteAttributesSetRouteAttribute, RouteAttributesDeleteRouteAttribute, RouteAttributesClearRouteAttribute.
In addition route planner can take into account difficulties received from other external sources (providers). Functions RouteAttributesSubscribeToDataProvider and RouteAttributesUnsubscribeFromDataProvider allow managing of the sources supported (available list can be get using RouteAttributesGetAttributesProviderList function).
RouteAttributesStoreToBlob function generates binary dump of all session routing difficulties which can be loaded later by RouteAttributesLoadFromBlob function.
For analyze purposes RouteAttributesGetPassedAttributesList function may be useful.
RouteOptimizerModule
RouteOptimizer module of MapCenter server offers functions of two kinds - basic and extended. Basic set of functions offers only route waypoint sequence optimization but extended functions are capable of solving optimal shipment delivery plans for a set of defined vehicle kinds. There are two modes of the optimization - the first takes into account only straight distances between waypoints, but the second default method (switching parameter routeoptimizerparams.calcinterpointlengths by use of function RoutePlannerSetParamValue) calculates all distances on roads. The second method is much slower and is performed with a set of parameters taking into account while route calculating: vehicle parameters, driver parameters and road parameters. The parameters can be maintained by following RoutePlanner module functions: RoutePlannerVehicleParamsGet2, RoutePlannerVehicleParamsSet2, RoutePlannerDriverParamsGet, RoutePlannerDriverParamsSet, RoutePlannerRoadParamsGet, RoutePlannerRoadParamsSet. If not explicitly set, the parameters have some default values.
Basic functions are RouteOptimizerOptimizeRoute and RouteOptimizerSimpleOptimizeRoute. Function RouteOptimizerOptimizeRoute works on at least two waypoints (route entries) stored in the sesssion. A list of waypoints is maintained by following functions: RoutePlannerEntriesGet, RoutePlannerEntriesSet, RoutePlannerEntriesSetWithDescription, RoutePlannerEntryAdd, RoutePlannerEntryAddWithDescription, RoutePlannerEntryInsert, RoutePlannerEntryInsertWithDescription, RoutePlannerEntryMove, RoutePlannerEntryComplexMove, RoutePlannerEntryRemove, RoutePlannerEntrySet, RoutePlannerEntrySetWithDescription, RoutePlannerEntryReverse, RoutePlannerEntriesClear. After calculating the route can be stored in the session. Function RouteOptimizerSimpleOptimizeRoute optimizes a route using its own parameters and waypoint list which optionally can replace session settings.
Extended version of the module has one main function RouteOptimizerSolveProblem. It takes into account the list of waypoints stored in the server session as described above, but waypoints can be augmented with additional properties by marking one of them as a depot point (functions RouteOptimizerSetDepotEntry and RouteOptimizerGetDepotEntry) and assigning to them delivery time windows and delivery shipment data and times (functions RouteOptimizerGetEntryTimeWindows, RouteOptimizerClearEntryTimeWindows, RouteOptimizerAddEntryTimeWindow, RouteOptimizerAddEntryTimeWindows, RouteOptimizerSetEntryTimeWindows, RouteOptimizerGetEntryDeliveryShipments, RouteOptimizerAddEntryDeliveryShipment, RouteOptimizerAddEntryDeliveryShipments, RouteOptimizerClearEntryDeliveryShipments, RouteOptimizerSetEntryDeliveryShipments, RouteOptimizerGetEntryShipmentDeliveryPickupTimes, RouteOptimizerSetEntryShipmentDeliveryPickupTimes). The function generates a set of routes dividing optimally the set of waypoints and assigning them to vehicles defined using following functions: VehicleRepositoryAddVehicle, VehicleRepositoryRemoveVehicle, VehicleRepositoryVehicleGet, VehicleRepositoryVehicleSet, VehicleRepositoryVehiclesGet, VehicleRepositoryVehiclesSet, VehicleRepositoryVehiclesClear, VehicleRepositoryRoadParamsGet, VehicleRepositoryRoadParamsSet, VehicleRepositoryDriverParamsGet, VehicleRepositoryDriverParamsSet, VehicleRepositoryVehicleViaTollGet, VehicleRepositoryVehicleViaTollSet. There is also posibility to set some incompatibilities between shipments and vehicles (functions RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet, RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet, RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet).
ActivateMapFile function.
Activates map file identified by FileName. The file must be
one of loaded map files.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:FileName
Name of the map file.
Type: WideString
AddGroupIcon function.
Adds new icon to the object set.
Module: ObjectsModule
Result type: TSoapAddGroupIcon__mcsResult
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
GroupIcon
Icon transferred as a byte stream.
Type: TByteDynArray
AdminDropSession function.
Removes given session with all its data. Administrative
rights are required.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:SessionID
Session identifier.
Type: WideString
SessionIP
IP address of client application, which is owner of the session.
Type: WideString
SessionUserName
Name of user assigned to session.
Type: WideString
AppendGroup function.
Inserts new object group to the object set.
Module: ObjectsModule
Result type: TSoapAppendGroup__mcsResult
Parameters:TableName
Table name.
Type: WideString
VisibleFields
Names of fields essential for the object group - other fields in object set are not important for the object group.
Type: TWideStringArray
AppendObject function.
Inserts new object to the object set.
Module: ObjectsModule
Result type: TSoapAppendObject__mcsResult
Parameters:TableName
Table name.
Type: WideString
FieldNames
Names of object fields to be set. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
CaptionPosition
Position of object name being drawn on maps nearby its icon.
It is the alignment of object name with reference to its icon. Supported values
are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Type: TCaptionPosition
AppendObjectCircle function.
Inserts new or overwrites existing circle within a shape
list tied with object identified by given ID. The object will be locked after
the call.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
MapRadius
Circle radius in meters.
Type: Double
ShapeID
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Type: Integer
AppendObjectEllipse function.
Inserts new or overwrites existing ellipse within a shape
list tied with object identified by given ID. The object will be locked after
the call.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
ShapeID
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Type: Integer
AppendObjectPolygon function.
Inserts new or overwrites existing polygon within a shape
list tied with object identified by given ID. The object will be locked after
the call.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
ShapeID
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Type: Integer
AppendObjectPolyline function.
Inserts new or overwrites existing polyline within a shape
list tied with object identified by given ID. The object will be locked after
the call.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
ShapeID
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Type: Integer
AppendObjectRectangle function.
Inserts new or overwrites existing rectangle within a shape
list tied with object identified by given ID. The object will be locked after
the call.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
ShapeID
Shape identifier. Value -1 is required in case of new shape insertion. New sequence identifier will be generated automatically.
Type: Integer
AppendObjects function.
Inserts a set of new objects to the object set.
Module: ObjectsModule
Result type: TSoapAppendObjects__mcsResult
Parameters:TableName
Table name.
Type: WideString
FieldNames
Names of object fields to be set. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
CaptionPosition
A list of positions of object name being drawn on maps
nearby its icon. It is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Type: TCaptionPositionArray
AuthCreateGroup function.
Adds user group.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:GroupName
User group name.
Type: WideString
GroupComment
User group comment.
Type: WideString
AuthCreateUser function.
Adds user account.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:Username
Username.
Type: WideString
Password
Password.
Type: WideString
Comment
Comment.
Type: WideString
AccountEnabled
Option of account enabling.
Type: Boolean
AuthDeleteGroup function.
Removes user group.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:GroupName
User group name.
Type: WideString
AuthDeleteUser function.
Removes user's account.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:Username
Username.
Type: WideString
AuthGetGroup function.
Returns user group comment.
Module: BaseModule
Result type: TSoapAuthGetGroup__mcsResult
Parameters:GroupName
User group name.
Type: WideString
AuthGetGroupsList function.
Returns a list of user groups.
Module: BaseModule
Result type: TSoapAuthGetGroupsList__mcsResult
AuthGetUserParamEx function.
Returns a value of user's additional parameter.
Module: BaseModule
Result type: TSoapAuthGetUserParamEx__mcsResult
Parameters:Username
Username.
Type: WideString
ParamName
Parameter name.
Type: WideString
AuthGetUserParams function.
Returns user's properties.
Module: BaseModule
Result type: TSoapAuthGetUserParams__mcsResult
Parameters:Username
Username.
Type: WideString
AuthGetUsersList function.
Returns a list of server users.
Module: BaseModule
Result type: TSoapAuthGetUsersList__mcsResult
AuthModifyGroup function.
Modifies user group properties.
Returns value from error
code
table.
Module: BaseModule
Result type: Integer
Parameters:GroupName
User group name.
Type: WideString
GroupComment
User group comment.
Type: WideString
AuthModifyUser function.
Modifies user's account.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:Username
Username.
Type: WideString
Comment
Comment.
Type: WideString
AccountEnabled
Option of account enabling.
Type: Boolean
AuthModifyUserPassword function.
Modifies user's password.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:Username
Username.
Type: WideString
Password
New password.
Type: WideString
AuthSetUserParamEx function.
Sets a value for user's additional parameter. If the
parameter does not exist, it will be created.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:Username
Username.
Type: WideString
ParamName
Parameter name.
Type: WideString
ParamValue
Parameter value.
Type: WideString
CancelEditGroup function.
Unlocks object group identified by given ID.
Returns
value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
CancelEditObject function.
Unlocks object identified by given ID.
Returns value
from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
CancelEditObjectFields function.
Unlocks the currently opened object set locked by EditObjectFields
function (requires administrative privileges).
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:CheckUpdate function.
Returns a statistic information about data changed by other users since last call of that function.
Module: ObjectsModule
Result type: TSoapCheckUpdate__mcsResult
Parameters:TableName
Table name.
Type: WideString
ClearMapSelection function.
Removes all session selections, i.e. selections of found map
elements.
Returns value from error code
table.
Module: SearchModule
Result type: Integer
Parameters:ClearSetFilter function.
Disables all filters performed on the object set by the
server session. All objects are available from now.
Returns value from error
code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
ConvertMapToScreen function.
Converts geographic coordinates to screen coordinates (image pixels).
Module: MapModule
Result type: TSoapConvertMapToScreen__mcsResult
Parameters:MapAltitude
Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of the image. It must be positive value.
Type: Integer
BitmapHeight
Height of the image. It must be positive value.
Type: Integer
ConvertScreenToMap function.
Converts screen coordinates (image pixels) to geographic ones.
Module: MapModule
Result type: TSoapConvertScreenToMap__mcsResult
Parameters:MapAltitude
Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of the image. It must be positive value.
Type: Integer
BitmapHeight
Height of the image. It must be positive value.
Type: Integer
ScreenPoints
A list of screen points to be converted. Their coordinates may be negative or higher than given image sizes.
Type: TSoapTPointsArray
CreateObjectSet function.
Creates a new object set (requires administrative
privileges).
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:AConnectionString
Object set parameters transferred as a semicolon separated string in form "Parameter1=Value1;Parameter2=Value2;...". Available parameters are: DBName, UserName, UserPassword. Parameters may be placed in any order.
Type: WideString
FieldTypes
New types of corresponding object fields. Following values
are supported:
- Character or string field = 0x01
- 16-bit integer field
= 0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field =
0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
-
Date field = 0x09
- Time field = 0x0A
- Date and time field =
0x0B
Type: TDynamicByteArray
FieldSize
Sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.
Type: TDynamicIntegerArray
FieldPrecision
Precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.
Type: TDynamicIntegerArray
FieldInfo
Parameters of corresponding object fields. It is a bit
vector for each field - each bit deals with one parameter:
- key field =
0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
-
indexed field = 0x08
- not null field (value required) = 0x10
Type: TDynamicByteArray
FieldFunctions
Specific features of corresponding object fields. Following
values are supported:
- name (object name being drawn on maps) = 0x01
-
city (for geocoding purposes) = 0x02
- street (for geocoding purposes) =
0x03
- number (for geocoding purposes) = 0x04
- postal code (for
geocoding purposes) = 0x05
- country (for geocoding purposes) = 0x0F
Type: TDynamicByteArray
SaveToDisk
Option of saving new object set to the disk. If false, object set will be volatile - only for current session.
Type: Boolean
CreateSessionID function.
Creates a new server session.
Module: BaseModule
Result type: TSoapCreateSessionID__mcsResult
DeactivateMapFile function.
Deactivates map file identified by FileName. The file must
be one of loaded map files.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:FileName
Name of the map file.
Type: WideString
Degeocode function.
Returns (degeocodes) geographic information for a list of given geographic points. An administrative and only the closest urbanistic and topographic information concerning each point is generated.
Module: MapModule
Result type: TSoapDegeocode__mcsResult
Parameters:MapAltitude
Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of a map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of a map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
QueryRadius
Search radius in meters. It must be nonnegative value.
Type: Double
DegeocodeLayers
List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.
Type: TWideStringArray
OnlyNamedEntries
If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.
Type: Boolean
UseViewVisibility
If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.
Type: Boolean
DegeocodeAtPoint function.
Returns (degeocodes) geographic information for the given geographic point. An information for all given layers maching the given search radius is generated.
Module: MapModule
Result type: TSoapDegeocodeAtPoint__mcsResult
Parameters:MapAltitude
Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of a map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of a map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
QueryRadius
Search radius in meters. It must be nonnegative value.
Type: Double
MaxElems
Maximum number of required resultant elements. It must be nonnegative value, 0 means no limits. Elements of each resultant category are counted independently.
Type: Integer
DegeocodeLayers
List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.
Type: TWideStringArray
OnlyNamedEntries
If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.
Type: Boolean
UseViewVisibility
If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.
Type: Boolean
DegeocodeEx function.
Returns (degeocodes) geographic information for a list of given geographic points. Only the closest information concerning each point is generated (for all given layers).
Module: MapModule
Result type: TSoapDegeocodeEx__mcsResult
Parameters:MapAltitude
Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of a map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of a map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
QueryRadius
Search radius in meters. It must be nonnegative value.
Type: Double
DegeocodeLayers
List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.
Type: TWideStringArray
OnlyNamedEntries
If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.
Type: Boolean
UseViewVisibility
If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.
Type: Boolean
DegeocodeExWithAttributes function.
Returns (degeocodes) geographic information for a list of given geographic points. Only the closest information concerning each point is generated (for all given layers). For future use.
Module: MapModule
Result type: TSoapDegeocodeExWithAttributes__mcsResult
Parameters:MapAltitude
Zoom of a map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of a map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of a map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
QueryRadius
Search radius in meters. It must be nonnegative value.
Type: Double
DegeocodeLayers
List of required degeocode layers. List of the layers can be received using GetDegeocodeLayers function.
Type: TWideStringArray
OnlyNamedEntries
If this option is on, the function ommits unnamed map elements, i.e. roads, forests without names. Otherwise all elements are taking into account.
Type: Boolean
UseViewVisibility
If this option is on, the function ommits those map elements, which are not displayed in the given zoom. Otherwise all elements are taking into account.
Type: Boolean
DegeocodeGetParamValue function.
Returns a value for given parameter of degeocoding stored in
the session. Parameter value meanings:
* degeocodeparams.degeocodetime -
time of degeocoding within a day, when value 1/24 means 01:00 a.m, 2/24 means
02:00 a.m. and so on (by default it is 09:00 a.m.)
*
degeocodeparams.vehicletype - vehicle type for degeocoding purposes as defined
in the TVehicleEntry (default value is 0)
Module: MapModule
Result type: TSoapDegeocodeGetParamValue__mcsResult
Parameters:ParamName
Parameter name.
Type: WideString
DegeocodeSetParamValue function.
Sets a value for given parameter of degeocoding stored in
the session.
Returns value from error code
table.
Module: MapModule
Result type: Integer
Parameters:ParamName
Parameter name.
Type: WideString
ParamValue
Parameter value.
Type: WideString
DeleteGroup function.
Removes object group identified by given ID.
Returns
value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
DeleteGroupIcon function.
Removes an icon from the object set.
Returns value from
error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
IconID
Icon identifier.
Type: Integer
DeleteObject function.
Removes object identified by given ID.
Returns value
from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
DeleteObjects function.
Rmoves objects identified by given IDs.
Module: ObjectsModule
Result type: TSoapDeleteObjects__mcsResult
Parameters:TableName
Table name.
Type: WideString
DeleteObjectShape function.
Removes a shape from the shape list tied with object
identified by given ID.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
ShapeID
Shape identifier. Value -1 means all shapes.
Type: Integer
DropSession function.
Removes the session with all its data.
Returns value
from error code
table.
Module: BaseModule
Result type: Integer
Parameters:EditGroup function.
Locks an object group for changing.
Returns value from
error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
EditObject function.
Locks object identified by given ID for changing.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
EditObjectFields function.
Locks the currently opened object set for restructuring
(requires administrative privileges).
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:FilterByObjectShape function.
Filters currently opened object set. Function finds objects placed in or intersected with given object shape stored in the database. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.
Module: ObjectsModule
Result type: TSoapFilterByObjectShape__mcsResult
Parameters:TableName
Table name.
Type: WideString
ShapeID
Shape identifier.
Type: Integer
Limit
Result limitation.
Type: Integer
FilterByPoint function.
Filters currently opened object set. Function finds objects that are nearest to the given point. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.
Module: ObjectsModule
Result type: TSoapFilterByPoint__mcsResult
Parameters:TableName
Table name.
Type: WideString
Limit
Result limitation.
Type: Integer
FilterByRadius function.
Filters currently opened object set. Function finds objects placed in geographic circle with given middle point and radius. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.
Module: ObjectsModule
Result type: TSoapFilterByRadius__mcsResult
Parameters:TableName
Table name.
Type: WideString
Radius
Search radius (in meters).
Type: Integer
Limit
Result limitation.
Type: Integer
FilterByShape function.
Filters currently opened object set. Function finds objects placed in or intersected with given object shape. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects found. Object data may be obtained using GetNextResult_Set function.
Module: ObjectsModule
Result type: TSoapFilterByShape__mcsResult
Parameters:TableName
Table name.
Type: WideString
Limit
Result limitation.
Type: Integer
FilterByText function.
Filters currently opened object set using text or numeric search. Takes into account objects being results of previous filter performed by the server session on the object set. Function returns only number of objects matching given conditions. Object data may be obtained using GetNextResult_Set function.
Module: ObjectsModule
Result type: TSoapFilterByText__mcsResult
Parameters:TableName
Table name.
Type: WideString
FieldNames
Names of condition fields. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
Conditions
Search conditions for corresponding fields. Currently containment condition for text fields and equivalent condition for other fields are supported. In both cases string "=" should be given.
Type: TWideStringArray
Limit
Result limitation.
Type: Integer
ForwardCalc function.
Returns a destination point with given distance from the start point according to the given azimuth.
Module: MapModule
Result type: TSoapForwardCalc__mcsResult
Parameters:Length
Distance from the start point.
Type: Double
Azimuth
Requested azimuth. It must be an angle in degrees between 0 and 360 counterclockwise.
Type: Double
Geocode function.
Translates addresses to their geographic coordinates. For each address the function returns the geocode level, too.
Module: SearchModule
Result type: TSoapGeocode__mcsResult
Parameters:ASCIISearch
This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).
Type: Boolean
GeocodeEx function.
Translates an address to its geographic coordinates. More than one result can be proposed. The function returns the address found and its geocode level for each proposal.
Module: SearchModule
Result type: TSoapGeocodeEx__mcsResult
Parameters:ASCIISearch
This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).
Type: Boolean
MaxResultCount
Maximal result count. Function returns at most 100 results, so if the value is greater, length of resultant lists should be checked.
Type: Integer
GetActiveSessions function.
Return statistic information of all active server sessions.
Module: BaseModule
Result type: TSoapGetActiveSessions__mcsResult
GetAggregatedObjects function.
Returns identifiers of objects contained in shapes of given objects.
Module: ObjectsModule
Result type: TSoapGetAggregatedObjects__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetAggregatedObjectShapes function.
Returns identifiers of objects with shapes containing given objects.
Module: ObjectsModule
Result type: TSoapGetAggregatedObjectShapes__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetAvailableIconFormats function.
Returns a list of icon MIME formats used in localization functions.
Module: MapModule
Result type: TSoapGetAvailableIconFormats__mcsResult
GetAvailableImageFormats function.
Returns a list of image MIME formats used in functions returning maps as image files.
Module: MapModule
Result type: TSoapGetAvailableImageFormats__mcsResult
GetAvailableMapFiles function.
Returns a list of all currently loaded map files. When starting server loads all map files (files with extension .eff) from subdirectory DATA of server installation directory.
Module: BaseModule
Result type: TSoapGetAvailableMapFiles__mcsResult
GetCurrentSessionCount function.
Returns the number of currently processed server sessions.
Module: BaseModule
Result type: TSoapGetCurrentSessionCount__mcsResult
GetCurrentViewConfig function.
Returns current session view config.
Module: BaseModule
Result type: TSoapGetCurrentViewConfig__mcsResult
Parameters:GetDatabaseList function.
Returns a list of available databases of given type configured on the server.
Module: ObjectsModule
Result type: TSoapGetDatabaseList__mcsResult
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
GetDatabaseTableList function.
Returns a list of tables (object sets) available for given database type.
Module: ObjectsModule
Result type: TSoapGetDatabaseTableList__mcsResult
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
GetDefaultLayers function.
Returns a list of all default map layers.
Module: MapModule
Result type: TSoapGetDefaultLayers__mcsResult
Parameters:GetDegeocodeLayers function.
Returns a list of all map layers taking into account by degecode functions.
Module: MapModule
Result type: TSoapGetDegeocodeLayers__mcsResult
Parameters:GetGroupBinaryData function.
Returns a binary data tied with object group identified by given ID.
Module: ObjectsModule
Result type: TSoapGetGroupBinaryData__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetGroupIcon function.
Returns a bitmap being an icon assigned to the object group.
Module: ObjectsModule
Result type: TSoapGetGroupIcon__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetGroupIcons function.
Returns a list of all icons stored in a database.
Module: ObjectsModule
Result type: TSoapGetGroupIcons__mcsResult
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
GetGroupSettings function.
Returns settings of an object group.
Module: ObjectsModule
Result type: TSoapGetGroupSettings__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetGroupShapeSettings function.
Returns settings of an object group concerning shape visualization.
Module: ObjectsModule
Result type: TSoapGetGroupShapeSettings__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetLoadedMapsRegion function.
Returns geographic coordinates of rectangle bounding a sum of all active map file regions.
Module: BaseModule
Result type: TSoapGetLoadedMapsRegion__mcsResult
GetMapModules function.
Returns a list of delivered server modules.
Module: BaseModule
Result type: TSoapGetMapModules__mcsResult
GetMapPointLength function.
Calculates total length in meters of a path composed of given list of geographic points.
Module: MapModule
Result type: TSoapGetMapPointLength__mcsResult
Parameters:GetMaxSessionsCount function.
Returns the maximum number of simultaneously processed server sessions. Returns 0 if the number is not constrained.
Module: BaseModule
Result type: TSoapGetMaxSessionsCount__mcsResult
GetModifiedFields function.
Returns a list of database fields modified since last call of that function.
Module: ObjectsModule
Result type: TSoapGetModifiedFields__mcsResult
Parameters:GetNextResult_FieldSet function.
Returns values for given object field, for given part of the object set.
Module: ObjectsModule
Result type: TSoapGetNextResult_FieldSet__mcsResult
Parameters:TableName
Table name.
Type: WideString
FieldName
Name of requested field. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: WideString
GetNextResult_IDSet function.
Returns object identifiers and identifiers of their groups for the next part of the object set.
Module: ObjectsModule
Result type: TSoapGetNextResult_IDSet__mcsResult
Parameters:TableName
Table name.
Type: WideString
Limit
Requested object count.
Type: Integer
FromBeginning
Option of getting objects from beginning of the object set.
Type: Boolean
GetNextResult_PositionSet function.
Returns geographic information for given part of the object set.
Module: ObjectsModule
Result type: TSoapGetNextResult_PositionSet__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetNextResult_RemovedSet function.
Returns the next part of the object identifiers removed by other users.
Module: ObjectsModule
Result type: TSoapGetNextResult_RemovedSet__mcsResult
Parameters:TableName
Table name.
Type: WideString
Limit
Requested object count.
Type: Integer
GetNextResult_Set function.
Returns the next part of the object set. Values for given object fields, object identifiers and identifiers of their groups and geographic information are returned.
Module: ObjectsModule
Result type: TSoapGetNextResult_Set__mcsResult
Parameters:TableName
Table name.
Type: WideString
Limit
Requested object count.
Type: Integer
FieldNames
Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
FromBeginning
Option of getting objects from beginning of the object set.
Type: Boolean
GetNextResult_UpdatedSet function.
Returns the next part of the objects updated by other users. Values for given object fields, object identifiers and identifiers of their groups and geographic information are returned.
Module: ObjectsModule
Result type: TSoapGetNextResult_UpdatedSet__mcsResult
Parameters:TableName
Table name.
Type: WideString
Limit
Requested object count.
Type: Integer
FieldNames
Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
GetObject function.
Returns all properties of an object identified by given ID.
Module: ObjectsModule
Result type: TSoapGetObject__mcsResult
Parameters:TableName
Table name.
Type: WideString
FieldNames
Names of object fields to be returned. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
GetObjectAggregates function.
Returns aggregate values for object fields.
Module: ObjectsModule
Result type: TSoapGetObjectAggregates__mcsResult
Parameters:TableName
Table name.
Type: WideString
FieldNames
Names of requested fields. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
GetObjectBinaryData function.
Returns a binary data tied with object identified by given ID.
Module: ObjectsModule
Result type: TSoapGetObjectBinaryData__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetObjectCircles function.
Returns coordinates of circle(s) tied with object identified by given ID.
Module: ObjectsModule
Result type: TSoapGetObjectCircles__mcsResult
Parameters:TableName
Table name.
Type: WideString
CircleID
Circle identifier. If less then 0 - all circles of the object will be returned.
Type: Integer
GetObjectCount function.
Returns a count of objects in a object set.
Module: ObjectsModule
Result type: TSoapGetObjectCount__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetObjectEllipses function.
Returns coordinates of ellipse(s) tied with object identified by given ID.
Module: ObjectsModule
Result type: TSoapGetObjectEllipses__mcsResult
Parameters:TableName
Table name.
Type: WideString
EllipseID
Ellipse identifier. If less then 0 - all ellipses of the object will be returned.
Type: Integer
GetObjectFields function.
Returns a structure of object set currently opened.
Module: ObjectsModule
Result type: TSoapGetObjectFields__mcsResult
Parameters:TableName
Table name.
Type: WideString
GetObjectPolygons function.
Returns coordinates of polygon(s) tied with object identified by given ID.
Module: ObjectsModule
Result type: TSoapGetObjectPolygons__mcsResult
Parameters:TableName
Table name.
Type: WideString
PolygonID
Polygon identifier. If less then 0 - all polygons of the object will be returned.
Type: Integer
GetObjectPolylines function.
Returns coordinates of polyline(s) tied with object identified by given ID.
Module: ObjectsModule
Result type: TSoapGetObjectPolylines__mcsResult
Parameters:TableName
Table name.
Type: WideString
PolylineID
Polyline identifier. If less then 0 - all polylines of the object will be returned.
Type: Integer
GetObjectRectangles function.
Returns coordinates of rectangle(s) tied with object identified by given ID.
Module: ObjectsModule
Result type: TSoapGetObjectRectangles__mcsResult
Parameters:TableName
Table name.
Type: WideString
RectangleID
Rectangle identifier. If less then 0 - all rectangles of the object will be returned.
Type: Integer
GetProjections function.
Returns a list of supported map projections.
Module: MapModule
Result type: TSoapGetProjections__mcsResult
GetRemovedFields function.
Returns a list of database fields removed since last call of that function.
Module: ObjectsModule
Result type: TSoapGetRemovedFields__mcsResult
Parameters:GetScreenPointLength function.
Calculates total length in meters of a path composed of given list of screen points.
Module: MapModule
Result type: TSoapGetScreenPointLength__mcsResult
Parameters:MapAltitude
Zoom of the map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of the image. It must be positive value.
Type: Integer
BitmapHeight
Height of the image. It must be positive value.
Type: Integer
ScreenPoints
A list of screen points to be converted. Their coordinates may be negative or higher than given image sizes.
Type: TSoapTPointsArray
GetServerVersion function.
Returns versions of the server and data components.
Module: BaseModule
Result type: TSoapGetServerVersion__mcsResult
GetSessionComment function.
Gets session comment.
Module: BaseModule
Result type: TSoapGetSessionComment__mcsResult
Parameters:GetSessionLanguageContext function.
Gets session language context.
Module: BaseModule
Result type: TSoapGetSessionLanguageContext__mcsResult
Parameters:ContextIndex
Context level (0-2).
Type: Integer
GetSessionLifetimeSeconds function.
Returns a time interval (in seconds), which inactive server session is removed after.
Module: BaseModule
Result type: TSoapGetSessionLifetimeSeconds__mcsResult
GetTiledMapLayers function.
Returns a list of all layers supported by RenderTiledMap function.
Module: MapModule
Result type: TSoapGetTiledMapLayers__mcsResult
Parameters:GetViewConfigList function.
Returns list od current view config files. When starting server loads all map files (files with extension .efc) from subdirectory DATA of server installation directory.
Module: BaseModule
Result type: TSoapGetViewConfigList__mcsResult
Parameters:GetVisibleGroups function.
Returns object group visibility.
Module: ObjectsModule
Result type: TSoapGetVisibleGroups__mcsResult
Parameters:TableName
Table name.
Type: WideString
InverseCalc function.
Calculates a length in meters and azimuths between two geographic poins.
Module: MapModule
Result type: TSoapInverseCalc__mcsResult
Parameters:KeepSession function.
Enforces keeping the session available.
Returns value
from error code
table.
Module: BaseModule
Result type: Integer
Parameters:LoadCurrentViewConfig function.
Loads current session view config from blob.
Returns
value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:ViewConfigBlob
View config file.
Type: TByteDynArray
LocalizeAddObjectPositions function.
Adds new positions to the positions collection of the given
localized object saved in the server session. The positions are appended at the
end of the collection. If the RemovePreviousPositions option is active for the
localized object, earlier added positions are removed. New positions are from
now displayed on maps rendered for the session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:EntityID
The unique localized object identifier.
Type: Integer
StringFields
Values for all string fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).
FloatFields
Values for all numeric fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).
Type: TSoapTFloatArrayArray
LocalizeGetObjectVisibility function.
Returns information about visibility of all localized object in collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeGetObjectVisibility__mcsResult
Parameters:LocalizeIconAdd function.
Adds a new icon to the icons collection saved in the server
session. The icon is appended at the end of the collection.
Returns value
from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:IconData
An icon transferred as a byte stream.
Type: TByteDynArray
LocalizeIconClear function.
Removes all icons from the icons collection saved in the
server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:LocalizeIconGet function.
Returns properties of an icon contained in the icons collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeIconGet__mcsResult
Parameters:ItemIndex
Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.
Type: Integer
LocalizeIconGetCount function.
Returns the number of icons in the icons collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeIconGetCount__mcsResult
Parameters:LocalizeIconIDToItemIndex function.
Returns an index of an icon in the icons collection saved in the server session - the icon with the given identifier .
Module: LocalizeModule
Result type: TSoapLocalizeIconIDToItemIndex__mcsResult
Parameters:IconId
A unique icon identifier.
Type: Integer
LocalizeIconRemove function.
Removes an icon from the icons collection saved in the
server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:ItemIndex
Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.
Type: Integer
LocalizeIconSet function.
Changes properties of an icon contained in the icons
collection saved in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:ItemIndex
Index of an icon in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.
Type: Integer
IconData
An icon transferred as a byte stream.
Type: TByteDynArray
LocalizeNumFieldsAdd function.
Adds a new field to the numeric fields collection saved in
the server session. The field is appended at the end of the collection.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:Name
Field name.
Type: WideString
ShowOnInfo
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Type: Boolean
LocalizeNumFieldsClear function.
Removes all fields from the numeric fields collection saved
in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:LocalizeNumFieldsGet function.
Returns properties of a field contained in the numeric fields collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeNumFieldsGet__mcsResult
Parameters:Index
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.
Type: Integer
LocalizeNumFieldsGetCount function.
Returns the number of fields in the numeric fields collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeNumFieldsGetCount__mcsResult
Parameters:LocalizeNumFieldsRemove function.
Removes a field from the numeric fields collection saved in
the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:Index
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.
Type: Integer
LocalizeNumFieldsSet function.
Changes properties of a field contained in the numeric
fields collection saved in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:Index
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeNumFieldsGetCount function.
Type: Integer
Name
Field name.
Type: WideString
ShowOnInfo
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Type: Boolean
LocalizeObjectAdd function.
Adds a new object to the localized objects collection saved
in the server session. The object is appended at the end of the collection.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:EntityID
The unique object identifier.
Type: Integer
Name
Object name displayed by the last position of an object on the map, providing the ShowName option is active.
Type: WideString
ShowName
Information on whether to display the name by the last position of an object on the map.
Type: Boolean
IconID
A unique identifier of icon saved in the icons collection in the server session.
Type: Integer
ShowIcon
Information on whether to display the icon by the last position of an object on the map.
Type: Boolean
IconColor
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
PathColor
The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
PathWidth
The width of the track created by the object positions (measured in pixels).
Type: Integer
Size
The size of the position marker in the track, measured in pixels.
Type: Integer
RemovePreviousPositions
Information on whether to delete the previous object positions while localizing new positions of the object.
Type: Boolean
PointsConnected
Information on whether to connect the object positions into a track.
Type: Boolean
ShowDirection
Information on whether to display direction arrows on track lines.
Type: Boolean
LocalizeObjectAddWithPositions function.
Adds a new object to the localized objects collection saved
in the server session. The object is appended at the end of the collection. The
object is added together with a list of positions.
Returns value from error
code
table.
Module: LocalizeModule
Result type: Integer
Parameters:EntityID
The unique object identifier.
Type: Integer
Name
Object name displayed by the last position of an object on the map, providing the ShowName option is active.
Type: WideString
ShowName
Information on whether to display the name by the last position of an object on the map.
Type: Boolean
IconID
A unique identifier of icon saved in the icons collection in the server session.
Type: Integer
ShowIcon
Information on whether to display the icon by the last position of an object on the map.
Type: Boolean
IconColor
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
PathColor
The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
PathWidth
The width of the track created by the object positions (measured in pixels).
Type: Integer
Size
The size of the position marker in the track, measured in pixels.
Type: Integer
RemovePreviousPositions
Information on whether to delete the previous object positions while localizing new positions of the object.
Type: Boolean
PointsConnected
Information on whether to connect the object positions into a track.
Type: Boolean
ShowDirection
Information on whether to display direction arrows on track lines.
Type: Boolean
StringFields
Values for all string fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).
FloatFields
Values for all numeric fields contained in the collection saved in the server session (for all positions given in ObjectPositions parameter).
Type: TSoapTFloatArrayArray
LocalizeObjectClear function.
Removes all objects from the localized objects collection
saved in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:LocalizeObjectEntityIDToItemIndex function.
Returns an index of an object in the localized objects collection saved in the server session - the object with the given identifier .
Module: LocalizeModule
Result type: TSoapLocalizeObjectEntityIDToItemIndex__mcsResult
Parameters:EntityID
The unique object identifier.
Type: Integer
LocalizeObjectGet function.
Returns properties of an object contained in the localized objects collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeObjectGet__mcsResult
Parameters:ItemIndex
Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.
Type: Integer
ShowDirection
Information on whether to display direction arrows on track lines.
Type: Boolean
LocalizeObjectGetCount function.
Returns the number of objects in the localized objects collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeObjectGetCount__mcsResult
Parameters:LocalizeObjectPositionAdd function.
Adds a new object position to the positions collection of
the given localized object saved in the server session. The position is appended
at the end of the collection. If the RemovePreviousPositions option is active
for the localized object, earlier added positions are removed. The new position
is from now displayed on maps rendered for the session.
Returns value from
error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:EntityID
The unique localized object identifier.
Type: Integer
NumFields
Values for all numeric fields contained in the collection saved in the server session.
Type: TFloatArray
StrFields
Values for all string fields contained in the collection saved in the server session.
Type: TWideStringArray
Time
Time (in the GMT time zone) of the position (number of days since 30-12-1899 12:00 AM).
Type: Double
Description
The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.
Type: WideString
ShowDescription
Information on whether to display the description of the position of the object on the map.
Type: Boolean
ShowName
Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).
Type: Boolean
IconID
A unique identifier of icon saved in the icons collection in the server session.
Type: Integer
ShowIcon
Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).
Type: Boolean
IconColor
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
LocalizeObjectPositionClear function.
Removes all object positions from the positions collection
of the given localized object saved in the server session.
Returns value
from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:EntityID
The unique localized object identifier.
Type: Integer
LocalizeObjectPositionGet function.
Returns properties of an object position contained in the positions collection of the given localized object saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeObjectPositionGet__mcsResult
Parameters:EntityID
The unique localized object identifier.
Type: Integer
ItemIndex
Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.
Type: Integer
LocalizeObjectPositionGetCount function.
Returns the number of object positions in the positions collection of the given localized object saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeObjectPositionGetCount__mcsResult
Parameters:EntityID
The unique localized object identifier.
Type: Integer
LocalizeObjectPositionRemove function.
Removes an object position from the positions collection of
the given localized object saved in the server session.
Returns value from
error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:EntityID
The unique localized object identifier.
Type: Integer
ItemIndex
Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.
Type: Integer
LocalizeObjectPositionSet function.
Changes properties of an object position contained in the
positions collection of the given localized object saved in the server
session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:EntityID
The unique localized object identifier.
Type: Integer
ItemIndex
Index of an object position in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectPositionGetCount function.
Type: Integer
NumFields
Values for all numeric fields contained in the collection saved in the server session.
Type: TFloatArray
StrFields
Values for all string fields contained in the collection saved in the server session.
Type: TWideStringArray
Time
Time (in the GMT time zone) of the position (number of days since 30-12-1899 12:00 AM).
Type: Double
Description
The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.
Type: WideString
ShowDescription
Information on whether to display the description of the position of the object on the map.
Type: Boolean
ShowName
Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).
Type: Boolean
IconID
A unique identifier of icon saved in the icons collection in the server session.
Type: Integer
ShowIcon
Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).
Type: Boolean
IconColor
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
LocalizeObjectRemove function.
Removes an object from the localized objects collection
saved in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:ItemIndex
Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.
Type: Integer
LocalizeObjectSet function.
Changes properties of an object contained in the localized
objects collection saved in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:ItemIndex
Index of an object in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.
Type: Integer
EntityID
The unique object identifier.
Type: Integer
Name
Object name displayed by the last position of an object on the map, providing the ShowName option is active.
Type: WideString
ShowName
Information on whether to display the name by the last position of an object on the map.
Type: Boolean
IconID
A unique identifier of icon saved in the icons collection in the server session.
Type: Integer
ShowIcon
Information on whether to display the icon by the last position of an object on the map.
Type: Boolean
IconColor
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
PathColor
The color of the track created by the object positions. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
PathWidth
The width of the track created by the object positions (measured in pixels).
Type: Integer
Size
The size of the position marker in the track, measured in pixels.
Type: Integer
RemovePreviousPositions
Information on whether to delete the previous object positions while localizing new positions of the object.
Type: Boolean
PointsConnected
Information on whether to connect the object positions into a track.
Type: Boolean
ShowDirection
Information on whether to display direction arrows on track lines.
Type: Boolean
LocalizeSetObjectVisibility function.
Changes the visibility of all localized object in collection
saved in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:ObjectVisibility
A list of localized objects visibility informations. Length of the list must equal the number of objects in the localized objects collection.
Type: TBooleanArray
LocalizeStrFieldsAdd function.
Adds a new field to the string fields collection saved in
the server session. The field is appended at the end of the collection.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:Name
Field name.
Type: WideString
ShowOnInfo
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Type: Boolean
LocalizeStrFieldsClear function.
Removes all fields from the string fields collection saved
in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:LocalizeStrFieldsGet function.
Returns properties of a field contained in the string fields collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeStrFieldsGet__mcsResult
Parameters:Index
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.
Type: Integer
LocalizeStrFieldsGetCount function.
Returns the number of fields in the string fields collection saved in the server session.
Module: LocalizeModule
Result type: TSoapLocalizeStrFieldsGetCount__mcsResult
Parameters:LocalizeStrFieldsRemove function.
Removes a field from the string fields collection saved in
the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:Index
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.
Type: Integer
LocalizeStrFieldsSet function.
Changes properties of a field contained in the string fields
collection saved in the server session.
Returns value from error code
table.
Module: LocalizeModule
Result type: Integer
Parameters:Index
Index of a field in the collection. It must be a value between 0 and count-1, when count may be obtained using LocalizeStrFieldsGetCount function.
Type: Integer
Name
Field name.
Type: WideString
ShowOnInfo
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Type: Boolean
MapBaseConnect function.
Connects given server session to a database described with connection string and opens a object set containing records from the database. Any previous connection of the same database type should be closed by the session before - only one database of each type can be opened.
Module: ObjectsModule
Result type: TSoapMapBaseConnect__mcsResult
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
ConnectionString
Connection parameters transferred as a semicolon separated string in form "Parameter1=Value1;Parameter2=Value2;...". Available parameters are: DBName (it should be one of available database names returned by GetDatabaseList function), UserName, UserPassword. Parameters may be placed in any order.
Type: TConnectionString
MapBaseDisconnect function.
Disconnects given server session from a database. Some
connection of given database type should be active before.
Returns value
from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
MapBaseLoadFromBlob function.
Loads a database file (*.emd for objects or *.eld for
logistics) and opens the database for current session only with administrative
privileges. Function has same effect as if a database would be opened using MapBaseConnect
function, so the connection should be finalized by a call of MapBaseDisconnect
function.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
BinaryData
A database file content.
Type: TByteDynArray
MapBaseStoreToBlob function.
Returns current content of a database loaded previously using MapBaseLoadFromBlob function (for saving of any database changes to a file).
Module: ObjectsModule
Result type: TSoapMapBaseStoreToBlob__mcsResult
Parameters:DatabaseType
A type of database. Currently available are: Objects, Logistics.
Type: WideString
MultiGeocodeEx function.
Translates addresses to their geographic coordinates. More than one result for each address can be proposed. The function returns addresses found and the geocode levels for each proposal.
Module: SearchModule
Result type: TSoapMultiGeocodeEx__mcsResult
Parameters:ASCIISearch
This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be given).
Type: Boolean
MaxResultCount
Maximal result count. Function returns at most 100 results, so if the value is greater, length of resultant lists should be checked.
Type: Integer
PostGroup function.
Posts new data for object group identified by given ID. The
group should be locked by EditGroup
before. After success object group will be unlocked.
Returns value from
error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
VisibleFields
Names of fields essential for the object group - other fields in object set are not important for the object group.
Type: TWideStringArray
PostObject function.
Posts new data for object identified by given ID. The
object should be locked by EditObject
before. After success object will be unlocked.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
FieldNames
Names of object fields to be changed. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
CaptionPosition
Position of object name being drawn on maps nearby its icon.
It is the alignment of object name with reference to its icon. Supported values
are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Type: TCaptionPosition
PostObjects function.
Posts new data for a set of objects identified by given IDs.
Module: ObjectsModule
Result type: TSoapPostObjects__mcsResult
Parameters:TableName
Table name.
Type: WideString
FieldNames
Names of object fields to be changed. The list of all fields in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
CaptionPosition
A list of positions of object name being drawn on maps
nearby its icon. It is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Type: TCaptionPositionArray
ReloadMapFiles function.
Realoads all map files placed in subdirectory DATA of server
installation directory. All loaded map files are activated by default.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
RenderMapOnHWNDByPoint function.
Generates a map with a middle in a given point. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of all four corner points of the resultant map are returned, too.
Module: MapModule
Result type: TSoapRenderMapOnHWNDByPoint__mcsResult
Parameters:MapAltitude
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of requested map image. It must be positive value.
Type: Integer
BitmapHeight
Height of requested map image. It must be positive value.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
HWND
Handle of the control, which the map is rendered on.
Type: Integer
RenderMapOnHWNDByPointWithCopyright function.
Generates a map with a middle in a given point. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.
Module: MapModule
Result type: TSoapRenderMapOnHWNDByPointWithCopyright__mcsResult
Parameters:MapAltitude
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of requested map image. It must be positive value.
Type: Integer
BitmapHeight
Height of requested map image. It must be positive value.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
HWND
Handle of the control, which the map is rendered on.
Type: Integer
RenderMapOnHWNDByRect function.
Generates a map bounded by a given rectangle. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and the canvas may differ, so in addition the function returns effective corner points of the resultant map.
Module: MapModule
Result type: TSoapRenderMapOnHWNDByRect__mcsResult
Parameters:LeftUpPoint
Geographic coordinates of the left-up point of the requested map.
Type: TSoapTLongLatPoint
RightBottomPoint
Geographic coordinates of the bottom-down point of the requested map.
Type: TSoapTLongLatPoint
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of requested map image. It must be positive value.
Type: Integer
BitmapHeight
Height of requested map image. It must be positive value.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
HWND
Handle of the control, which the map is rendered on.
Type: Integer
RenderMapOnHWNDByRectWithCopyright function.
Generates a map bounded by a given rectangle. The map is rendered on a canvas (HDC) of pointed control (HWND), so the function works only if a client application is run on the same machine as the server. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and the canvas may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.
Module: MapModule
Result type: TSoapRenderMapOnHWNDByRectWithCopyright__mcsResult
Parameters:LeftUpPoint
Geographic coordinates of the left-up point of the requested map.
Type: TSoapTLongLatPoint
RightBottomPoint
Geographic coordinates of the bottom-down point of the requested map.
Type: TSoapTLongLatPoint
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of requested map image. It must be positive value.
Type: Integer
BitmapHeight
Height of requested map image. It must be positive value.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
HWND
Handle of the control, which the map is rendered on.
Type: Integer
RenderMapOnImageByPoint function.
Generates a map as image file with a middle in a given point. Geographic coordinates of all four corner points of the resultant map are returned, too.
Module: MapModule
Result type: TSoapRenderMapOnImageByPoint__mcsResult
Parameters:MimeType
Format of returned image. Supported formats can be received using GetAvailableImageFormats function.
Type: WideString
MapAltitude
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of requested map image. It must be positive value.
Type: Integer
BitmapHeight
Height of requested map image. It must be positive value.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderMapOnImageByPointWithCopyright function.
Generates a map as image file with a middle in a given point. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.
Module: MapModule
Result type: TSoapRenderMapOnImageByPointWithCopyright__mcsResult
Parameters:MimeType
Format of returned image. Supported formats can be received using GetAvailableImageFormats function.
Type: WideString
MapAltitude
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of requested map image. It must be positive value.
Type: Integer
BitmapHeight
Height of requested map image. It must be positive value.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderMapOnImageByRect function.
Generates a map as image file bounded by a given rectangle. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested image may differ, so in addition the function returns effective corner points of the resultant map.
Module: MapModule
Result type: TSoapRenderMapOnImageByRect__mcsResult
Parameters:MimeType
Format of returned image. Supported formats can be received using GetAvailableImageFormats function.
Type: WideString
LeftUpPoint
Geographic coordinates of the left-up point of the requested map.
Type: TSoapTLongLatPoint
RightBottomPoint
Geographic coordinates of the bottom-down point of the requested map.
Type: TSoapTLongLatPoint
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of requested map image. It must be positive value.
Type: Integer
BitmapHeight
Height of requested map image. It must be positive value.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderMapOnImageByRectWithCopyright function.
Generates a map as image file bounded by a given rectangle. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested image may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.
Module: MapModule
Result type: TSoapRenderMapOnImageByRectWithCopyright__mcsResult
Parameters:MimeType
Format of returned image. Supported formats can be received using GetAvailableImageFormats function.
Type: WideString
LeftUpPoint
Geographic coordinates of the left-up point of the requested map.
Type: TSoapTLongLatPoint
RightBottomPoint
Geographic coordinates of the bottom-down point of the requested map.
Type: TSoapTLongLatPoint
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Width of requested map image. It must be positive value.
Type: Integer
BitmapHeight
Height of requested map image. It must be positive value.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderSplitMapOnImageByPoint function.
Generates a map with a middle in a given point. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of all four corner points of the resultant map are returned, too.
Module: MapModule
Result type: TSoapRenderSplitMapOnImageByPoint__mcsResult
Parameters:MimeType
Format of returned images. Supported formats can be received using GetAvailableImageFormats function.
Type: WideString
MapAltitude
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Requested total width of map image. It must be positive value.
Type: Integer
BitmapHeight
Requested total height of map image. It must be positive value.
Type: Integer
TileWidth
Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.
Type: Integer
TileHeight
Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderSplitMapOnImageByPointWithCopyright function.
Generates a map with a middle in a given point. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of all four corner points of the resultant map are returned, too. Additionally returns copyrights of the map providers.
Module: MapModule
Result type: TSoapRenderSplitMapOnImageByPointWithCopyright__mcsResult
Parameters:MimeType
Format of returned images. Supported formats can be received using GetAvailableImageFormats function.
Type: WideString
MapAltitude
Zoom of requested map being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Requested total width of map image. It must be positive value.
Type: Integer
BitmapHeight
Requested total height of map image. It must be positive value.
Type: Integer
TileWidth
Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.
Type: Integer
TileHeight
Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderSplitMapOnImageByRect function.
Generates a map bounded by a given rectangle. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested total image may differ, so in addition the function returns effective corner points of the resultant map.
Module: MapModule
Result type: TSoapRenderSplitMapOnImageByRect__mcsResult
Parameters:MimeType
Format of returned images. Supported formats can be received using GetAvailableImageFormats function.
Type: WideString
LeftUpPoint
Geographic coordinates of the left-up point of the requested map.
Type: TSoapTLongLatPoint
RightBottomPoint
Geographic coordinates of the bottom-down point of the requested map.
Type: TSoapTLongLatPoint
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Requested total width of map image. It must be positive value.
Type: Integer
BitmapHeight
Requested total height of map image. It must be positive value.
Type: Integer
TileWidth
Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.
Type: Integer
TileHeight
Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderSplitMapOnImageByRectWithCopyright function.
Generates a map bounded by a given rectangle. The map is split into a list of image files forming a matrix of tiles. Geographic coordinates of the middle point and altitude of the resultant map are returned, too. The proportions of given geographic rectangle and requested total image may differ, so in addition the function returns effective corner points of the resultant map. Additionally returns copyrights of the map providers.
Module: MapModule
Result type: TSoapRenderSplitMapOnImageByRectWithCopyright__mcsResult
Parameters:MimeType
Format of returned images. Supported formats can be received using GetAvailableImageFormats function.
Type: WideString
LeftUpPoint
Geographic coordinates of the left-up point of the requested map.
Type: TSoapTLongLatPoint
RightBottomPoint
Geographic coordinates of the bottom-down point of the requested map.
Type: TSoapTLongLatPoint
MapRotation
An angle defining a rotation of the map (degrees between 0 and 360).
Type: Double
MapTilt
An angle defining a tilt of the map (degrees between -30 and 30).
Type: Double
MapProjection
Name of required map projection. Supported projections can be received using GetProjections function.
Type: WideString
MapProjectionParams
For future use.
Type: WideString
BitmapWidth
Requested total width of map image. It must be positive value.
Type: Integer
BitmapHeight
Requested total height of map image. It must be positive value.
Type: Integer
TileWidth
Width of single map tile. It must be positive value. If the total width is not divisible by the value, additional space on all tiles in the last column is filled with white.
Type: Integer
TileHeight
Height of single map tile. It must be positive value. If the total height is not divisible by the value, additional space on all tiles in the last row is filled with white.
Type: Integer
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderTiledMap function.
Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher.
Module: MapModule
Result type: TSoapRenderTiledMap__mcsResult
Parameters:MimeType
Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".
Type: WideString
PositionX
X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Type: Integer
PositionY
Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Type: Integer
Zoom
Discrete zoom. It must be a value between 0 and 19.
Type: Integer
TiledMapLayers
List of required layers. List of all supported layers can be received using GetTiledMapLayers function.
Type: TWideStringArray
RenderTiledMapEx function.
Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher.
Module: MapModule
Result type: TSoapRenderTiledMapEx__mcsResult
Parameters:MimeType
Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".
Type: WideString
PositionX
X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Type: Integer
PositionY
Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Type: Integer
Zoom
Discrete zoom. It must be a value between 0 and 19.
Type: Integer
TiledMapLayers
List of required layers. List of all supported layers can be received using GetTiledMapLayers function.
Type: TWideStringArray
VisibleLayers
List of required map layers. List of all map layers can be received using GetDefaultLayers function.
Type: TWideStringArray
RenderTiledMapWithCopyright function.
Generates a map split into a list of normalized image files forming a matrix of tiles. Each image has 256x256 pixels. Zoom has discrete values between 0 and 19. Dimentions of the matrix are returned, too. If the given zoom equals 0, total region of loaded maps is normalized to a single tile, so in this case the resultant matrix has size 1x1. If zoom equals 1, the map is zoomed in and the map region is divided by 2 in both dimensions, so the matrix has size 2x2, and so on. The maximum size of resultant matrix is 8x8, and it's possible for zoom with value 3 and higher. Additionally returns copyrights of the map providers.
Module: MapModule
Result type: TSoapRenderTiledMapWithCopyright__mcsResult
Parameters:MimeType
Format of returned images. Supported formats can be received using GetAvailableImageFormats function. Optionally, the image format can be augmented by additional tile parameters using semicolon as a delimiter, e.g. "image/png;DPI=192", "image/png;TileSize=512".
Type: WideString
PositionX
X-position (row number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Type: Integer
PositionY
Y-position (column number) of the first tile of the resultant matrix in the global matrix available for the given zoom. Its value depends on zoom and must be between 0 and 2^Zoom - 1.
Type: Integer
Zoom
Discrete zoom. It must be a value between 0 and 19.
Type: Integer
TiledMapLayers
List of required layers. List of all supported layers can be received using GetTiledMapLayers function.
Type: TWideStringArray
RouteAttributesAddAlongRouteAttribute function.
Adds new polyline road-along placed routing difficulty to the session. Polyline coordinates will be generated automatically between given start and finish points.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesAddAlongRouteAttribute__mcsResult
Parameters:GenerateID
Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.
Type: Boolean
ReturnRepresentation
Option of returning all points of generated polyline.
Type: Boolean
RouteAttributesAddLineAttribute function.
Adds new polyline routing difficulty to the session.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesAddLineAttribute__mcsResult
Parameters:GenerateID
Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.
Type: Boolean
RouteAttributesAddPointAttribute function.
Adds new point routing difficulty to the session.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesAddPointAttribute__mcsResult
Parameters:GenerateID
Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.
Type: Boolean
RouteAttributesAddPolygonAttribute function.
Adds new polygonal routing difficulty to the session.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesAddPolygonAttribute__mcsResult
Parameters:Polygon
Geographic coordinates of all points of the difficulty polygon.
Type: TSoapTLongLatPointArray
GenerateID
Option of auto-generating difficulty unique identifier. If set to true, identifier given in difficulty properties will be ignored.
Type: Boolean
RouteAttributesClearRouteAttribute function.
Removes all routing difficulties stored in the session.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:RouteAttributesDeleteRouteAttribute function.
Removes routing difficulty identified by given
identifier.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:AttributeID
Identifier of difficulty being deleted.
Type: Integer
RouteAttributesExecuteDataProviderAction function.
Executes one of the action supported for given routing
difficulty provider.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:Provider
Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.
Type: WideString
ActionName
Action name. The list of currently supported actions can be get using RouteAttributesGetDataProviderActions function.
Type: WideString
RouteAttributesGetAttributesProviderList function.
Returns a list of supported routing difficulty providers.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesGetAttributesProviderList__mcsResult
Parameters:RouteAttributesGetDataProviderActions function.
Returns all actions supported for given routing difficulty provider.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesGetDataProviderActions__mcsResult
Parameters:Provider
Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.
Type: WideString
RouteAttributesGetDataProviderParams function.
Returns all parameter names and values for given routing difficulty provider.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesGetDataProviderParams__mcsResult
Parameters:Provider
Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Type: WideString
RouteAttributesGetPassedAttributesList function.
Retrieves a list of routing difficulties used while the last route calculation (if routeattributes.collectrouteattributes option is on).
Module: RouteAttributesModule
Result type: TSoapRouteAttributesGetPassedAttributesList__mcsResult
Parameters:RouteAttributesGetRouteAttribute function.
Returns properties of routing difficulty identified by given identifier.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesGetRouteAttribute__mcsResult
Parameters:AttributeID
Identifier of difficulty.
Type: Integer
RouteAttributesGetRouteAttributes function.
Returns all routing difficulties stored in the session.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesGetRouteAttributes__mcsResult
Parameters:RouteAttributesGetRouteAttributeWithGeometry function.
Returns properties of routing difficulty identified by given identifier together with its gegraphic coordinates.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesGetRouteAttributeWithGeometry__mcsResult
Parameters:AttributeID
Identifier of difficulty.
Type: Integer
RouteAttributesGetSubscribedProvidersList function.
Returns a list of currently subscribed routing difficulty providers.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesGetSubscribedProvidersList__mcsResult
Parameters:RouteAttributesLoadFromBlob function.
Loads routing difficulties from binary representation.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:BinaryRepresentation
Binary representation of routing difficulties.
Type: TByteDynArray
RouteAttributesModifyAlongRouteAttribute function.
Modifies geographic properties of polyline road-along placed routing difficulty identified by given identifier.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesModifyAlongRouteAttribute__mcsResult
Parameters:AttributeID
Identifier of difficulty being modified.
Type: Integer
ReturnRepresentation
Option of returning all points of generated polyline.
Type: Boolean
RouteAttributesModifyLineAttribute function.
Modifies geographic properties of polyline routing
difficulty identified by given identifier.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:AttributeID
Identifier of difficulty being modified.
Type: Integer
RouteAttributesModifyPointAttribute function.
Modifies geographic properties of point routing difficulty
identified by given identifier.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:AttributeID
Identifier of difficulty being modified.
Type: Integer
RouteAttributesModifyPolygonAttribute function.
Modifies geographic properties of polygonal routing
difficulty identified by given identifier.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:AttributeID
Identifier of difficulty being modified.
Type: Integer
RouteAttributesSetDataProviderParam function.
Sets a value for given parameter of routing difficulty
provider.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:Provider
Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Type: WideString
ParamName
Parameter name. The list of supported parameters can be get using RouteAttributesGetDataProviderParams function.
Type: WideString
ParamValue
Parameter value.
Type: WideString
RouteAttributesSetRouteAttribute function.
Modifies properties of routing difficulty identified by
given identifier.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:AttributeID
Identifier of difficulty being modified.
Type: Integer
RouteAttributesStoreToBlob function.
Stores all routing difficulties to binary representation.
Module: RouteAttributesModule
Result type: TSoapRouteAttributesStoreToBlob__mcsResult
Parameters:RouteAttributesSubscribeToDataProvider function.
Subcribes to one of supported routing difficulty
providers.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:Provider
Provider name. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Type: WideString
RouteAttributesUnsubscribeFromDataProvider function.
Unsubcribes from one of subscribed routing difficulty
providers.
Returns value from error code
table.
Module: RouteAttributesModule
Result type: Integer
Parameters:Provider
Provider name. The list of currently subscribed providers can be get using RouteAttributesGetSubscribedProvidersList function.
Type: WideString
RouteOptimizerAddEntryDeliveryShipment function.
Adds a new delivery shipment for a waypoint.
Returns
value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerAddEntryDeliveryShipments function.
Adds a list of delivery shipments for a waypoint.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerAddEntryPickupShipment function.
Adds a new pickup shipment for a waypoint. For future
use.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerAddEntryPickupShipments function.
Adds a list of pickup shipments for a waypoint. For future
use.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerAddEntryTimeWindow function.
Adds a new time window for a waypoint.
Returns value
from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerAddEntryTimeWindows function.
Adds a list of time windows for a waypoint.
Returns
value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerAddShipmentType function.
Defines within the server session a new shipment type which
is identified by an arbitrary name.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:ShipmentType
Name of the shipment type.
Type: WideString
RouteOptimizerClearEntryDeliveryShipments function.
Deletes all delivery shipments defined for a waypoint.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerClearEntryPickupShipments function.
Deletes all pickup shipments defined for a waypoint. For
future use.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerClearEntryTimeWindows function.
Deletes all time windows defined for a waypoint.
Returns
value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerGetDepotEntry function.
Gets the index of currently set depot waypoint.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerGetDepotEntry__mcsResult
Parameters:RouteOptimizerGetEntryDeliveryShipments function.
Returns a list of all delivery shipments defined for a waypoint.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerGetEntryDeliveryShipments__mcsResult
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerGetEntryPickupShipments function.
Returns a list of all pickup shipments defined for a waypoint. For future use.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerGetEntryPickupShipments__mcsResult
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerGetEntryShipmentDeliveryPickupTimes function.
Returns delivery and pickup times defined for a waypoint.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerGetEntryShipmentDeliveryPickupTimes__mcsResult
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerGetEntryTimeWindows function.
Returns a list of all time windows defined for a waypoint.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerGetEntryTimeWindows__mcsResult
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerOptimizeRoute function.
Optimizes a route in way of reordering a sequence of waypoints using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route (if it really was calculated) can be opionally stored in the server session for further processing. Function returns new waypoint order and resultant route features.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerOptimizeRoute__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
RouteOptimizeType
Route optimization type:
- from start to end = 0x00
- from start to best end = 0x01
- from best start to end = 0x02
- from
best start to best end = 0x03
- cycle on all points = 0x04
Type: Integer
CalculateRoute
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Type: Boolean
ReorderPoints
Indicates whether to store new waypoint order in the session replacing present list of waypoints.
Type: Boolean
ReturnRoutePlanEntriesDescription
Option of returning user or automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RouteOptimizerRemoveShipmentType function.
Deletes one of defined shipment types.
Returns value
from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:ShipmentType
Name of the shipment type to be deleted.
Type: WideString
RouteOptimizerSetDepotEntry function.
Marks one of the waypoints defined in the server session as
a depot.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:DepotEntryIndex
Index of the waypoint . It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerSetEntryDeliveryShipments function.
Sets a new set of delivery shipments for a waypoint.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerSetEntryPickupShipments function.
Sets a new set of pickup shipments for a waypoint. For
future use.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerSetEntryShipmentDeliveryPickupTimes function.
Sets new delivery and pickup times for a waypoint.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
DeliveryTime
Time of shipment delivery (in minutes).
Type: Integer
PickupTime
Time of shipment pickup (in minutes).
Type: Integer
RouteOptimizerSetEntryTimeWindows function.
Sets a new set of time windows for a waypoint.
Returns
value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:EntryIndex
Index of the waypoint. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RouteOptimizerShipmentTypesClear function.
Removes all shipment types defined in the server
session.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:RouteOptimizerShipmentTypesGet function.
Returns a list of currently defined shipment types.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerShipmentTypesGet__mcsResult
Parameters:RouteOptimizerShipmentTypesSet function.
Sets for the server session a new set of shipment types
replacing existing one, if present.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityAdd function.
Adds a new entry to the list of incompatibilities between
some two shipment types defined in the server session.
Returns value from
error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:ShipmentType1
First shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.
Type: WideString
ShipmentType2
Second shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.
Type: WideString
RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityClear function.
Deletes entire list of incompatibilities between some two
shipment types.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet function.
Returns a list of all incompatibilities between some shipment types defined in the server session.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet__mcsResult
Parameters:RouteOptimizerShipmentTypeToShipmentTypeIncompatibilitySet function.
Sets a new set of incompatibilities between shipment
types.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:ShipmentTypeToShipmentTypeIncompatibility
A list of incompatibility pairs.
RouteOptimizerSimpleOptimizeRoute function.
Optimizes a route in way of reordering a sequence of waypoints using given vehicle, driver and road parameters. Calculated route (if it really was calculated), waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns new waypoint order and resultant route features.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerSimpleOptimizeRoute__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
RouteOptimizeType
Route optimization type:
- from start to end = 0x00
- from start to best end = 0x01
- from best start to end = 0x02
- from
best start to best end = 0x03
- cycle on all points = 0x04
Type: Integer
CalculateRoute
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Type: Boolean
ReturnRoutePlanEntriesDescription
Option of returning automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
StoreDriverParamsInSession
Indicates whether to store given driver parameters in the session replacing present parameters.
Type: Boolean
StoreVehicleParamsInSession
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Type: Boolean
StoreRoadParamsInSession
Indicates whether to store given road parameters in the session replacing present parameters.
Type: Boolean
StoreRoutePlanEntriesInSession
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RouteOptimizerSolveProblem function.
Optimizes a shipment task for shipments defined for route waypoints returning a set of routes for vehicle categories stored in the server session.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerSolveProblem__mcsResult
Parameters:RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityAdd function.
Adds a new entry to the list of incompatibilities between
vehicle categories and shipment types defined in the server session.
Returns
value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:VehicleCategory
Vehicle category. The list of currently defined categories may be obtained using VehicleRepositoryVehiclesGet function.
Type: WideString
ShipmentType
Shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.
Type: WideString
RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityClear function.
Deletes entire list of incompatibilities between vehicle
categories and shipment types.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet function.
Returns a list of all incompatibilities between vehicle categories and shipment types defined in the server session.
Module: RouteOptimizerModule
Result type: TSoapRouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet__mcsResult
Parameters:RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilitySet function.
Sets a new set of incompatibilities between vehicle
categories and shipment types.
Returns value from error code
table.
Module: RouteOptimizerModule
Result type: Integer
Parameters:VehicleCategoryToShipmentTypeIncompatibility
A list of incompatibility pairs.
Type: TSoapTVehicleCategoryToShipmentTypeIncompatibilityArray
RoutePlannerCalculateAlternativeRoutesAndStore function.
Calculates an optimal and at most two alternative routes for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. The function optionally stores calculated routes in route repository. The optimal route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
Module: RouteRepositoryModule
Result type: TSoapRoutePlannerCalculateAlternativeRoutesAndStore__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
StoreFirstRouteInSession
Indicates whether to store first resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
StoreInRepository
Option of storing routes in the repository.
Type: Boolean
ReplaceRepository
Option of replacing old routes in the repository.
Type: Boolean
UseIdentsArray
Option of storing routes assigned with identifiers.
Type: Boolean
UseColorArray
Option of storing routes assigned with colors.
Type: Boolean
RoutePlannerCalculatePointDistanceFromRoute function.
Calculates distances from a route stored in the server session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerCalculatePointDistanceFromRoute__mcsResult
Parameters:MaxLength
Maximum distance taking into account while distance calculationg (in meters).
Type: Double
RoutePlannerCalculatePointWithinRouteBuffer function.
Recognizes whether given points belong to a buffer formed by a route stored in the server session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerCalculatePointWithinRouteBuffer__mcsResult
Parameters:BufferRadius
Buffer radius (in meters).
Type: Double
RoutePlannerCalculateRoute function.
Calculates a route for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerCalculateRoute__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
ReturnRoutePlanEntriesDescription
Option of returning user or automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerCalculateRouteDistanceMatrix function.
Calculates a set of routes for each given waypoints (from each point as a start point to all others as end points independently)
Module: RoutePlannerModule
Result type: TSoapRoutePlannerCalculateRouteDistanceMatrix__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
AssumeSymetricDistance
Option of missing of reverse route calculation.
Type: Boolean
RoutePlannerCalculateRouteFromGPSTrack function.
Calculates a route for a given list of waypoints given as a GPS track file using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerCalculateRouteFromGPSTrack__mcsResult
Parameters:BinaryFile
GPS track file stored in blob.
Type: TByteDynArray
BinaryFileFormat
File format:
- CSV = 0x00
- PLT = 0x01
Type: Integer
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerCalculateRoutesWithMultipleDepots function.
Calculates a set of routes beginning with given start points (depots). Each destination point is taken as an end point for subsequent route beginning with the nearest start point.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerCalculateRoutesWithMultipleDepots__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
RoutePlannerCalculateRoutesWithMultipleDepotsAndStore function.
Calculates a set of routes beginning with given start points (depots) and optionally stores them in route repository. Each destination point is taken as an end point for subsequent route beginning with the nearest start point.
Module: RouteRepositoryModule
Result type: TSoapRoutePlannerCalculateRoutesWithMultipleDepotsAndStore__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
StoreInRepository
Option of storing routes in the repository.
Type: Boolean
ReplaceRepository
Option of replacing old routes in the repository.
Type: Boolean
UseIdentsArray
Option of storing routes assigned with identifiers.
Type: Boolean
UseColorArray
Option of storing routes assigned with colors.
Type: Boolean
RoutePlannerCalculateRoutesWithSingleDepot function.
Calculates a set of routes beginning with common start point (depot). Each destination point is taken as an end point for subsequent route.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerCalculateRoutesWithSingleDepot__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
RoutePlannerCalculateRoutesWithSingleDepotAndStore function.
Calculates a set of routes beginning with common start point (depot) and optionally stores them in route repository. Each destination point is taken as an end point for subsequent route.
Module: RouteRepositoryModule
Result type: TSoapRoutePlannerCalculateRoutesWithSingleDepotAndStore__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
StoreInRepository
Option of storing routes in the repository.
Type: Boolean
ReplaceRepository
Option of replacing old routes in the repository.
Type: Boolean
UseIdentsArray
Option of storing routes assigned with identifiers.
Type: Boolean
UseColorArray
Option of storing routes assigned with colors.
Type: Boolean
RoutePlannerCalculateRouteWithBinaryResult function.
Calculates a route for a list of waypoints stored in the server session using vehicle, driver and road parameters stored in the session. If the parameters were not previously saved in the session, then default parameters are used. Calculated route can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).
Module: RoutePlannerModule
Result type: TSoapRoutePlannerCalculateRouteWithBinaryResult__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
ReturnRoutePlanEntriesDescription
Option of returning user or automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerDriverParamsGet function.
Returns current driver parameters stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerDriverParamsGet__mcsResult
Parameters:RoutePlannerDriverParamsSet function.
Sets new driver parameters in the session replacing present
parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerEntriesAdd function.
Adds new waypoints to waypoint list in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntriesAdd__mcsResult
Parameters:RoutePlanVisitTimes
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
RoutePlannerEntriesAddWithDescription function.
Adds new waypoints to waypoint list in the session. User
description for each waypoint can be set.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlanVisitTimes
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
RoutePlannerEntriesClear function.
Clears a waypoint list stored in the session.
Returns
value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerEntriesGet function.
Returns waypoint list stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntriesGet__mcsResult
Parameters:RoutePlannerEntriesGetCount function.
Returns a count of waypoints stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntriesGetCount__mcsResult
Parameters:RoutePlannerEntriesGetWithSnapPoints function.
Returns waypoint list stored in the session. Additionally waypoint snap points are returned.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntriesGetWithSnapPoints__mcsResult
Parameters:RoutePlannerEntriesSet function.
Sets waypoint list in the session replacing present list.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntriesSet__mcsResult
Parameters:RoutePlanVisitTimes
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
RoutePlannerEntriesSetAsDriveThrough function.
Sets waypoints in the session as precise points or with
tollerance.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerEntriesSetWithDescription function.
Sets waypoint list in the session replacing present list.
User description for each waypoint can be set.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlanVisitTimes
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
RoutePlannerEntryAdd function.
Appends a new waypoint to a waypoint list stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntryAdd__mcsResult
Parameters:RoutePlanVisitTime
Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
RoutePlannerEntryAddWithDescription function.
Appends a new waypoint with user description to a waypoint
list stored in the session.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlanVisitTime
Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
RoutePlanEntryDescription
Waypoint description.
Type: WideString
RoutePlannerEntryComplexMove function.
Moves many waypoints at given positions in waypoint list
stored in the session to another positons beginning with one specified
position.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:OldEntryIndexes
Indices of current waypoint positions in the waypoint list. Each must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: TDynamicIntegerArray
NewEntryIndex
Index of a target position in the waypoint list for the first of all waypoints to be moved. It must be a value between 0 and count, when count-1 may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RoutePlannerEntryGet function.
Gets parameters for a given waypoint from waypoint lists stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntryGet__mcsResult
Parameters:EntryIndex
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RoutePlannerEntryInsert function.
Inserts a new waypoint at a given position of waypoint list stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntryInsert__mcsResult
Parameters:EntryIndex
Index of a target position in the waypoint list. It must be a value between 0 and count, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RoutePlanVisitTime
Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
RoutePlannerEntryInsertWithDescription function.
Inserts a new waypoint with user description at a given
position of waypoint list stored in the session.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:EntryIndex
Index of a target position in the waypoint list. It must be a value between 0 and count, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RoutePlanVisitTime
Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
RoutePlanEntryDescription
Waypoint description.
Type: WideString
RoutePlannerEntryMove function.
Moves a waypoint from one position in waypoint list stored
in the session to another.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:OldEntryIndex
Index of current waypoint position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
NewEntryIndex
Index of a target position in the waypoint list. It must be a value between 0 and count, when count-1 may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RoutePlannerEntryRemove function.
Removes waypoint at given position in waypoint list stored
in the session.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:EntryIndex
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RoutePlannerEntryReverse function.
Reverses waypoint list.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerEntrySet function.
Sets parameters for a given waypoint from waypoint lists stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerEntrySet__mcsResult
Parameters:EntryIndex
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RoutePlanVisitTime
Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
RoutePlannerEntrySetWithDescription function.
Sets parameters and user description for a given waypoint
from waypoint lists stored in the session.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:EntryIndex
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
RoutePlanVisitTime
Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
RoutePlanEntryDescription
Waypoint description.
Type: WideString
RoutePlannerGetAvailableRoadTypes function.
Returns a list of road types.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetAvailableRoadTypes__mcsResult
Parameters:RoutePlannerGetParamValue function.
Returns a value for given parameter of routing stored in the session. List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetParamValue__mcsResult
Parameters:ParamName
Parameter name.
Type: WideString
RoutePlannerGetParamValues function.
Returns values for all parameters of routing stored in the
session. For color parameters value must be decimal number corresponding to
hexadecimal number 0x00BBGGRR (BB=blue, GG=green, RR=red). Parameter value
meanings:
* routeplanentries.flagstyle - style of waypoint indicators:
-
0 = rectangle without description
- 1 = rectangle with waypoint sequential
number beginning from number 1 for the first waypoint (default)
- 2 =
rectangle with description
- 3 = rectangle with description and waypoint
sequential number beginning from number 1 for the first waypoint
- 4 =
rectangle with "Start", "Via", "Stop" labels
- 5 = rectangle with multiline
description
- 6 = rectangle with multiline description and waypoint
sequential number beginning from number 1 for the first waypoint
- 7 = no
indicators
- 8 = circle
- 9 = circle with waypoint sequential number
beginning from number 1 for the first waypoint
*
routeplanentries.startflagcolor - color of the first waypoint indicator (default
value is green)
* routeplanentries.viaflagcolor - color of via waypoint
indicators (default value is purple)
* routeplanentries.finishflagcolor -
color of the last waypoint indicator (default value is green)
*
routeplanrepresentation.visible - option of route visibility:
- 0 =
disabled
- 1 = enabled (default)
* routeplanrepresentation.color - color
of the route (default value is green)
* routeplanrepresentation.width -
route width in pixels, only for value 1 for routeplanrepresentation.position
parameter (default value is 3)
* routeplanrepresentation.payroadvisible -
option of payed route segments visibility:
- 0 = disabled (default)
- 1
= enabled
* routeplanrepresentation.payroadcolor - color of payed route
segments (default value is red)
* routeplanrepresentation.payroadwidth -
payed route width in pixels, only for value 1 for
routeplanrepresentation.position parameter (default value is 3)
*
routeplanrepresentation.chargeroadvisible - option of charged route segments
visibility:
- 0 = disabled (default)
- 1 = enabled
*
routeplanrepresentation.chargeroadcolor - color of charged route segments
(default value is red)
* routeplanrepresentation.chargeroadwidth - charged
route width in pixels, only for value 1 for routeplanrepresentation.position
parameter (default value is 3)
* routeplanrepresentation.viatollroadvisible
- option of viaTOLL route segments visibility:
- 0 = disabled (default)
- 1 = enabled
* routeplanrepresentation.viatollroadcolor - color of viaTOLL
route segments (default value is red)
*
routeplanrepresentation.viatollroadwidth - viaTOLL route width in pixels, only
for value 1 for routeplanrepresentation.position parameter (default value is
3)
* routeplanrepresentation.position - route placement:
- 0 = under
roads (default)
- 1 = above roads
*
routeplanerparams.addpointtosnaplinetocalculation - distance between waypoint
and nearest road affects route length:
- 0 = disabled (default)
- 1 =
enabled
* routeplanerparams.attachtoroadfromdescription - waypoints are
placed on the named road given in function
RoutePlannerEntryAddWithDescription:
- 0 = disabled (default)
- 1 =
enabled
* routeplanerparams.cleancalculatedrouteondriverparamsmodification -
previously calculated route is removed from session after driver parameter
modification:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.cleancalculatedrouteonentriesmodification - previously
calculated route is removed from session after waypoint list modification:
-
0 = disabled
- 1 = enabled (default)
*
routeplanerparams.cleancalculatedrouteonrouteplanparamsmodification - previously
calculated route is removed from session after route planner parameter
modification:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.cleancalculatedrouteonvehicleparamsentriesmodification -
previously calculated route is removed from session after vehicle parameter
modification:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.hardroadrestrictions - impassable roads are always omitted
(even if target waypoint is set on that road):
- 0 = disabled (default)
- 1 = enabled
* routeplanerparams.snaptoblockedlinks - waypoint snap points
are placed on impassable roads too:
- 0 = disabled
- 1 = enabled
(default)
* routeplanerparams.snaptoferries - waypoints are placed on ferry
lines too:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.softferriesrestrictions - ferry lines are used when is no
other way, even if they are forbidden:
- 0 = disabled
- 1 = enabled
(default)
* routeplanerparams.useonewayrestritions - one-way restrictions
are on:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.useturnrestrictions - turn restrictions are on:
- 0 =
disabled
- 1 = enabled (default)
*
routeplanerparams.usesegmentrestrictions - for future use:
- 0 =
disabled
- 1 = enabled (default)
*
routeplanerparams.usestoredtimewindows - for future use:
- 0 =
disabled(default)
- 1 = enabled
* routeplanerparams.usepayroads -
toll-roads are accepted while routing:
- 0 = enabled (default)
- 1 =
softly disabled - enabled only when there is no other route to the target
waypoint
- 2 = hardly disabled - all payed roads are absolutelly
forbidden
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.useviatollroads - viaTOLL roads are accepted while
routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only
when there is no other route to the target waypoint
- 2 = hardly disabled -
all viaTOLL roads are absolutelly forbidden
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usechargeroads - charged roads are accepted while routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only when there is
no other route to the target waypoint
- 2 = hardly disabled - all charged
roads are absolutelly forbidden
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.useunpavedroads - unpaved roads are accepted while
routing:
- 0 = enabled (default)
- 1 = softly disabled - enabled only
when there is no other route to the target waypoint
- 2 = hardly disabled -
all unpaved roads are absolutelly forbidden
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usemaxvehicleweight - weight restrictions are on (parameter
takes effect when LogisticsAttributes provider is subscribed):
- 0 =
disabled - all weight restrictions are ignored
- 1 = softly enabled - weight
restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - all weight restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usemaxvehicleweightperaxle - weight per axle restrictions are
on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all weight per axle restrictions are ignored
- 1 = softly
enabled - weight per axle restrictions are ignored only when there is no other
route to the target waypoint
- 2 = hardly enabled - all weight per axle
restrictions are taken absolutelly into consideration (default)
- 3 =
setting dervied from routeattributes.hardblockedroadattributesrestrictions
parameter
* routeplanerparams.usemaxvehiclelength - length restrictions are
on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - all length restrictions are ignored
- 1 = softly enabled -
length restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - all length restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usemaxvehiclewidth - width restrictions are on (parameter
takes effect when LogisticsAttributes provider is subscribed):
- 0 =
disabled - all width restrictions are ignored
- 1 = softly enabled - width
restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - all width restrictions are taken absolutelly
into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.usemaxvehicleheight - height restrictions are on (parameter
takes effect when LogisticsAttributes provider is subscribed):
- 0 =
disabled - all height restrictions are ignored
- 1 = softly enabled - height
restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - all height restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.hazmatgeneralhazardousmaterials - hazardous material
restrictions are on (parameter takes effect when LogisticsAttributes provider is
subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly
enabled - the restrictions are ignored only when there is no other route to the
target waypoint
- 2 = hardly enabled - the restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.hazmatexplosivematerials - explosive material restrictions are
on (parameter takes effect when LogisticsAttributes provider is subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly enabled - the
restrictions are ignored only when there is no other route to the target
waypoint
- 2 = hardly enabled - the restrictions are taken absolutelly into
consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.hazmatgoodsharmfultowater - water harmful material
restrictions are on (parameter takes effect when LogisticsAttributes provider is
subscribed):
- 0 = disabled - the restrictions are ignored
- 1 = softly
enabled - the restrictions are ignored only when there is no other route to the
target waypoint
- 2 = hardly enabled - the restrictions are taken
absolutelly into consideration (default)
- 3 = setting dervied from
routeattributes.hardblockedroadattributesrestrictions parameter
*
routeplanerparams.recalculaterouteonturnrestrictionfail - a route is
recalculated when there is no way to route without turning off restrictions:
- 0 = disabled
- 1 = enabled (default)
*
routeplanerparams.breakmatrixcalculationonfail - route matrix is broken at first
calculation failure:
- 0 = disabled (default)
- 1 = enabled
*
routeplanerparams.raportcrossroads - route itinerary contains crossroads:
-
0 = disabled (default)
- 1 = only crossroad for named streets
- 2 = all
crossroads enabled
* routeplanerparams.defaultdrivethroughviapoints - all
waypoints (except of the first and the last) are used as drive through waypoints
with tollerance:
- 0 = disabled (default)
- 1 = enabled
*
routeplanerparams.defaultdrivethroughradius - drive through waypoint radius
(drive tollerance in meters):
- 0 = precise waypoints
- any positive
value = waypoints with tollerance (default value is 10000 = 10km)
*
routeplanerparams.enableregionalroadsfortracks - all regional roads are allowed
for trucks:
- 0 = disabled (default)
- 1 = enabled
*
routeplanerparams.routereportformat - for future use
*
routeoptimizerparams.calcinterpointlengths - route optimizer calculates full
routes between waypoints:
- 0 = disabled (default)
- 1 = enabled
*
routeoptimizerparams.routeoptimizecalculatetype - type of route calculating
while optimization (parameter takes effect when option
routeoptimizerparams.calcinterpointlengths is enabled):
- 0 = shortest
route
- 1 = quickest route (default)
- 2 = cheapest route
*
routeoptimizerparams.planninghorizon - maximal duration of a route planning (in
days, default value is 10)
* routeoptimizerparams.maxrouteduration - maximal
duration of a single route (in minutes, default value is 540 = 9 hours)
*
routeoptimizerparams.maxwaitingtime - maximal time of waiting at a single route
point (in minutes, default value is 120 = 2 hours)
*
routeoptimizerparams.maxcumuldrivingbeforeshortbreak - maximal duration of a
contigous driving without a break (in minutes, default value is 270 = 4.5
hours)
* routeoptimizerparams.drivetimemargin - maximal tollerance time at a
single route point (in minutes, default value is 2)
*
routeoptimizerparams.drivetimemarginpercent - maximal tollerance at a single
route point (in percents, default value is 5)
*
routeoptimizerparams.loadingtimemargin - maximal tollerance for shipment loading
time at a single route point (in minutes, default value is 2)
*
routeoptimizerparams.loadingtimemarginpercent - maximal tollerance for shipment
loading at a single route point (in percents, default value is 5)
*
routeoptimizerparams.unloadingtimemargin - maximal tollerance for shipment
unloading time at a single route point (in minutes, default value is 2)
*
routeoptimizerparams.unloadingtimemarginpercent - maximal tollerance for
shipment unloading at a single route point (in percents, default value is 5)
* routeoptimizerparams.separatediffrentpoints - assumption of non-zero distance
between two equivalent route points:
- 0 = disabled
- 1 = enabled
(default)
* routeattributes.hardblockedroadattributesrestrictions -
impassable traffic difficulties are always omitted (even if the target waypoint
is set within the difficulty):
- 0 = disabled (default) - all difficulty
parameters are ignored when routing to the target waypoint
- 1 = enabled -
all difficulty parameters are taken absolutelly into consideration
- 2 =
enabled - all difficulty parameters except of Closed parameter are taken
absolutelly into consideration, but Closed is ignored when routing to the target
waypoint
* routeattributes.allowentertoblockedzone - impassable difficulties
being zones blocked for routing are ignored when the target waypoint is set in
such zone:
- 0 = disabled (default)
- 1 = enabled
*
routeattributes.collectrouteattributes - routing difficulties are collected for
analyze purposes:
- 0 = disabled (default)
- 1 = enabled
*
routeattributes.showblockedattributes - routing difficulties which have
influenced on the last calculated route are drawn on maps as red bubbles:
-
0 = disabled (default)
- 1 = enabled
*
routeattributes.showvisitedattributes - routing difficulties which were taken
into account but haven't influenced on the last calculated route are drawn on
maps as green bubbles:
- 0 = disabled (default)
- 1 = enabled
*
routeattributes.maxaltitudeforattributes - maximal altitude for bubbles drawn
after setting up routeattributes.showblockedattributes or
routeattributes.showvisitedattributes (default value 0 means no limit)
*
routeattributes.speedprofilestype - for future use
*
logistictollattributes.currentcurrency - current currency 3-letter international
abbreviation (default value is PLN)
*
logistictollattributes.preferedvinettespandays - vinette time perdiod for
vinette road (in days, default value is 7-14)
*
logistictollattributes.defaultaxles - default number of axles for vehicles
(default value is 2)
* logistictollattributes.defaultemission - default
emission standard for vehicles (default value is 5)
*
logistictollattributes.defaulthasdpf - vehicles are supported with the DPF
filter:
- 0 = disabled
- 1 = enabled (default)
*
logistictollattributes.notaxcosts - costs are returned without the tax:
- 0
= disabled (default)
- 1 = enabled
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetParamValues__mcsResult
Parameters:RoutePlannerGetRouteItinerary function.
Returns an itinerary for a claculated route stored in the server session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetRouteItinerary__mcsResult
Parameters:RoutePlannerGetRouteLogisticTOLLSummary function.
Returns toll costs for a calaculated route stored in the server session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetRouteLogisticTOLLSummary__mcsResult
Parameters:RoutePlannerGetRouteRepresentation function.
Returns geographic route representation for a claculated route stored in the server session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetRouteRepresentation__mcsResult
Parameters:RoutePlannerGetRouteRepresentationWithBinaryResult function.
Returns geographic route representation in binary format for a claculated route stored in the server session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetRouteRepresentationWithBinaryResult__mcsResult
Parameters:RoutePlannerGetRouteSummary function.
Returns summary for a claculated route stored in the server session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetRouteSummary__mcsResult
Parameters:ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
RoutePlannerGetRouteViaTollSummary function.
Returns viaTOLL summary for a calaculated route stored in the server session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerGetRouteViaTollSummary__mcsResult
Parameters:RoutePlannerRoadParamsGet function.
Returns current road parameters stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerRoadParamsGet__mcsResult
Parameters:RoutePlannerRoadParamsSet function.
Sets new road parameters in the session replacing present
parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerRoadViaTollParamsGet function.
Returns current viaTOLL parameters stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerRoadViaTollParamsGet__mcsResult
Parameters:RoutePlannerRoadViaTollParamsSet function.
Sets new viaTOLL parameters in the session replacing present
parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerRouteClear function.
Removes a route last calculated and stored in the
session.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerRouteLoadFromBlob function.
Loads current route from binary representation.
Returns
value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:BinaryRepresentation
Binary route representation.
Type: TByteDynArray
RoutePlannerRouteLoadFromDatabase function.
Loads current route from database.
Returns value from
error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerRouteStoreToBlob function.
Stores current route to binary representation.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerRouteStoreToBlob__mcsResult
Parameters:RoutePlannerRouteStoreToDatabase function.
Stores current route to database.
Returns value from
error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerSetParamValue function.
Sets a value for given parameter of routing stored in the
session. List of all supported parameters may be obtained by RoutePlannerGetParamValues
function.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:ParamName
Parameter name.
Type: WideString
ParamValue
Parameter value.
Type: WideString
RoutePlannerSimpleCalculateAlternativeRoutesAndStore function.
Calculates an optimal and at most two alternative routes for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters, and optionally stores them in route repository. The optimal route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
Module: RouteRepositoryModule
Result type: TSoapRoutePlannerSimpleCalculateAlternativeRoutesAndStore__mcsResult
Parameters:RoutePlannerParams
A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
Type: TWideStringArray
SubscribeProviders
A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Type: TWideStringArray
DriveThroughEntries
Waypoint settings as precise points or with tollerance.
Type: TSoapTDriveThroughArray
RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
StoreFirstRouteInSession
Indicates whether to store first resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
StoreInRepository
Option of storing routes in the repository.
Type: Boolean
ReplaceRepository
Option of replacing old routes in the repository.
Type: Boolean
UseIdentsArray
Option of storing routes assigned with identifiers.
Type: Boolean
UseColorArray
Option of storing routes assigned with colors.
Type: Boolean
StoreDriverParamsInSession
Indicates whether to store given driver parameters in the session replacing present parameters.
Type: Boolean
StoreVehicleParamsInSession
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Type: Boolean
StoreRoadParamsInSession
Indicates whether to store given road parameters in the session replacing present parameters.
Type: Boolean
StoreRoutePlanEntriesInSession
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Type: Boolean
StoreRoutePlannerParamsInSession
Indicates whether to store given routing parameters in the session replacing present parameters.
Type: Boolean
StoreSubscribeProvidersInSession
Indicates whether to set given routing difficulty provider list in the session replacing present list.
Type: Boolean
StoreDriveThroughEntriesInSession
Indicates whether to store given waypoint properties in the session replacing present properties.
Type: Boolean
RoutePlannerSimpleCalculateRoute function.
Calculates a route for a given list of waypoints using given vehicle, driver and road parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerSimpleCalculateRoute__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
CalculateRoute
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Type: Boolean
ReturnRoutePlanEntriesDescription
Option of returning automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
StoreDriverParamsInSession
Indicates whether to store given driver parameters in the session replacing present parameters.
Type: Boolean
StoreVehicleParamsInSession
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Type: Boolean
StoreRoadParamsInSession
Indicates whether to store given road parameters in the session replacing present parameters.
Type: Boolean
StoreRoutePlanEntriesInSession
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerSimpleCalculateRoute2 function.
Calculates a route for a given list of waypoints using given vehicle, driver, road and viaTOLL parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerSimpleCalculateRoute2__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
CalculateRoute
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Type: Boolean
ReturnRoutePlanEntriesDescription
Option of returning automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
ReturnViaTollRoadResults
Option of returning resultant viaTOLL results divided into separated road types.
Type: Boolean
StoreDriverParamsInSession
Indicates whether to store given driver parameters in the session replacing present parameters.
Type: Boolean
StoreVehicleParamsInSession
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Type: Boolean
StoreRoadParamsInSession
Indicates whether to store given road parameters in the session replacing present parameters.
Type: Boolean
StoreRoutePlanEntriesInSession
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerSimpleCalculateRoute2WithBinaryResult function.
Calculates a route for a given list of waypoints using given vehicle, driver, road and viaTOLL parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).
Module: RoutePlannerModule
Result type: TSoapRoutePlannerSimpleCalculateRoute2WithBinaryResult__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
CalculateRoute
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Type: Boolean
ReturnRoutePlanEntriesDescription
Option of returning automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
ReturnViaTollRoadResults
Option of returning resultant viaTOLL results divided into separated road types.
Type: Boolean
StoreDriverParamsInSession
Indicates whether to store given driver parameters in the session replacing present parameters.
Type: Boolean
StoreVehicleParamsInSession
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Type: Boolean
StoreRoadParamsInSession
Indicates whether to store given road parameters in the session replacing present parameters.
Type: Boolean
StoreRoutePlanEntriesInSession
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerSimpleCalculateRoute3 function.
Calculates a route for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerSimpleCalculateRoute3__mcsResult
Parameters:RoutePlannerParams
A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
Type: TWideStringArray
SubscribeProviders
A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Type: TWideStringArray
DriveThroughEntries
Waypoint settings as precise points or with tollerance.
Type: TSoapTDriveThroughArray
RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
CalculateRoute
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Type: Boolean
ReturnRoutePlanEntriesDescription
Option of returning automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
ReturnViaTollRoadResults
Option of returning resultant viaTOLL results divided into separated road types.
Type: Boolean
ReturnLogisticTOLLResults
Option of returning toll road costs divided into separated countries.
Type: Boolean
StoreDriverParamsInSession
Indicates whether to store given driver parameters in the session replacing present parameters.
Type: Boolean
StoreVehicleParamsInSession
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Type: Boolean
StoreRoadParamsInSession
Indicates whether to store given road parameters in the session replacing present parameters.
Type: Boolean
StoreRoutePlanEntriesInSession
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Type: Boolean
StoreRoutePlannerParamsInSession
Indicates whether to store given routing parameters in the session replacing present parameters.
Type: Boolean
StoreSubscribeProvidersInSession
Indicates whether to set given routing difficulty provider list in the session replacing present list.
Type: Boolean
StoreDriveThroughEntriesInSession
Indicates whether to store given waypoint properties in the session replacing present properties.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerSimpleCalculateRoute3WithBinaryResult function.
Calculates a route for a given list of waypoints using given vehicle, driver, road, viaTOLL and additional routing parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).
Module: RoutePlannerModule
Result type: TSoapRoutePlannerSimpleCalculateRoute3WithBinaryResult__mcsResult
Parameters:RoutePlannerParams
A list of additional routing parameter values. Each parameter may be passed as a pair "ParamName=ParamValue". List of all supported parameters may be obtained by RoutePlannerGetParamValues function.
Type: TWideStringArray
SubscribeProviders
A list of difficulty providers to be used. The list of supported providers can be get using RouteAttributesGetAttributesProviderList function.
Type: TWideStringArray
DriveThroughEntries
Waypoint settings as precise points or with tollerance.
Type: TSoapTDriveThroughArray
RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
CalculateRoute
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Type: Boolean
ReturnRoutePlanEntriesDescription
Option of returning automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
ReturnViaTollRoadResults
Option of returning resultant viaTOLL results divided into separated road types.
Type: Boolean
ReturnLogisticTOLLResults
Option of returning toll road costs divided into separated countries.
Type: Boolean
StoreDriverParamsInSession
Indicates whether to store given driver parameters in the session replacing present parameters.
Type: Boolean
StoreVehicleParamsInSession
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Type: Boolean
StoreRoadParamsInSession
Indicates whether to store given road parameters in the session replacing present parameters.
Type: Boolean
StoreRoutePlanEntriesInSession
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Type: Boolean
StoreRoutePlannerParamsInSession
Indicates whether to store given routing parameters in the session replacing present parameters.
Type: Boolean
StoreSubscribeProvidersInSession
Indicates whether to set given routing difficulty provider list in the session replacing present list.
Type: Boolean
StoreDriveThroughEntriesInSession
Indicates whether to store given waypoint properties in the session replacing present properties.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerSimpleCalculateRouteWithBinaryResult function.
Calculates a route for a given list of waypoints using given vehicle, driver and road parameters. Calculated route, waypoints and the calculate parameters can be opionally stored in the server session for further processing. Function returns resultant route features (route representation in binary format).
Module: RoutePlannerModule
Result type: TSoapRoutePlannerSimpleCalculateRouteWithBinaryResult__mcsResult
Parameters:RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
CalculateRoute
Indicates whether to really calculate a route or not. If the option is set to False, the function can only store waypoints and other parameters in the session.
Type: Boolean
ReturnRoutePlanEntriesDescription
Option of returning automatic generated geographical waypoint descriptons.
Type: Boolean
ReturnRouteRepresentation
Option of returning geographic route representation - a list of all points forming a route.
Type: Boolean
ReturnRouteItinerary
Option of returning resultant route itinerary - a list of all route events.
Type: Boolean
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
StoreDriverParamsInSession
Indicates whether to store given driver parameters in the session replacing present parameters.
Type: Boolean
StoreVehicleParamsInSession
Indicates whether to store given vehicle parameters in the session replacing present parameters.
Type: Boolean
StoreRoadParamsInSession
Indicates whether to store given road parameters in the session replacing present parameters.
Type: Boolean
StoreRoutePlanEntriesInSession
Indicates whether to store given waypoints in the session replacing present list of waypoints.
Type: Boolean
StoreRouteInSession
Indicates whether to store resultant route in the session for futher processing, i.e. for map presentation or getting route itinerary.
Type: Boolean
RoutePlannerVehicleParamExGet function.
Returns current value for additional vehicle parameter stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerVehicleParamExGet__mcsResult
Parameters:ParamName
Parameter name.
Type: WideString
RoutePlannerVehicleParamExSet function.
Sets a new value for additional vehicle parameter in the
session.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:ParamName
Parameter name.
Type: WideString
PasamValue
Parameter value.
Type: WideString
RoutePlannerVehicleParamsExGet function.
Returns current values for all additional vehicle parameters stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerVehicleParamsExGet__mcsResult
Parameters:RoutePlannerVehicleParamsGet function.
Returns current vehicle parameters stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerVehicleParamsGet__mcsResult
Parameters:RoutePlannerVehicleParamsGet2 function.
Returns current extended vehicle parameters stored in the session.
Module: RoutePlannerModule
Result type: TSoapRoutePlannerVehicleParamsGet2__mcsResult
Parameters:RoutePlannerVehicleParamsSet function.
Sets new vehicle parameters in the session replacing present
parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RoutePlannerVehicleParamsSet2 function.
Sets new extended vehicle parameters in the session
replacing present parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:RouteRepositoryAddRoute function.
Adds a new (last calculated) route to the repository.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:RouteRepositoryAddRouteWithIdent function.
Adds a new (last calculated) identified route to the
repository.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Ident
Route identifier.
Type: Integer
RouteRepositoryCalculatePointDistanceFromRoute function.
Calculates distances from a routes stored in the server session's repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryCalculatePointDistanceFromRoute__mcsResult
Parameters:MaxLength
Maximum distance taking into account while distance calculationg (in meters).
Type: Double
RouteRepositoryClear function.
Clears the route repository.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:RouteRepositoryFetchRoute function.
Fetches existing route from the repository. It becomes
current session route.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
RouteRepositoryFetchRouteWithIdent function.
Fetches existing route from the repository. It becomes
current session route.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Ident
Route identifier.
Type: Integer
RouteRepositoryGetRouteItinerary function.
Returns itinerary for route existing in the repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryGetRouteItinerary__mcsResult
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
RouteRepositoryGetRouteItineraryByIdent function.
Returns itinerary for route existing in the repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryGetRouteItineraryByIdent__mcsResult
Parameters:Ident
Route identifier.
Type: Integer
RouteRepositoryGetRouteRepresentation function.
Returns geographic route representation for route existing in the repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryGetRouteRepresentation__mcsResult
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
RouteRepositoryGetRouteRepresentationByIdent function.
Returns geographic route representation for route existing in the repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryGetRouteRepresentationByIdent__mcsResult
Parameters:Ident
Route identifier.
Type: Integer
RouteRepositoryGetRoutes function.
Returns all routes stored in the repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryGetRoutes__mcsResult
Parameters:RouteRepositoryGetRoutesCount function.
Returns the count of routes stored int the repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryGetRoutesCount__mcsResult
Parameters:RouteRepositoryGetRouteSummary function.
Returns summary for route existing in the repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryGetRouteSummary__mcsResult
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
RouteRepositoryGetRouteSummaryByIdent function.
Returns summary for route existing in the repository.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryGetRouteSummaryByIdent__mcsResult
Parameters:Ident
Route identifier.
Type: Integer
ReturnRoadResults
Option of returning resultant route results divided into separated road types.
Type: Boolean
RouteRepositoryLoadFromBlob function.
Loads route repository from binary representation.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:BinaryRepresentation
Binary representation of route repository.
Type: TByteDynArray
RouteRepositoryRemove function.
Removes existing route from the repository.
Returns
value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
RouteRepositoryRemoveWithIdent function.
Removes existing route from the repository.
Returns
value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Ident
Route identifier.
Type: Integer
RouteRepositoryReplaceRoute function.
Raplaces existing route in the route repository with the
last calculated.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
RouteRepositoryReplaceRouteWithIdent function.
Raplaces existing route in the route repository with the
last calculated.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Ident
Route identifier.
Type: Integer
RouteRepositorySetRouteColor function.
Sets color for route existing in the repository.
Returns
value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
Color
New route color.
Type: Integer
RouteRepositorySetRouteColorByIdent function.
Sets color for route existing in the repository.
Returns
value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Ident
Route identifier.
Type: Integer
Color
New route color.
Type: Integer
RouteRepositorySetRouteDescription function.
Sets description for route existing in the repository.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
Description
Route description.
Type: WideString
RouteRepositorySetRouteDescriptionByIdent function.
Sets description for route existing in the repository.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Ident
Route identifier.
Type: Integer
Description
Route description.
Type: WideString
RouteRepositorySetRouteVisibility function.
Enables/disables visibility on maps of route existing in the
respository.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Index
Index of a route. It must be a value between 0 and count-1, when count may be obtained using RouteRepositoryGetRoutesCount function.
Type: Integer
Visibility
Route visibility.
Type: Boolean
RouteRepositorySetRouteVisibilityByIdent function.
Enables/disables visibility on maps of route existing in the
respository.
Returns value from error code
table.
Module: RouteRepositoryModule
Result type: Integer
Parameters:Ident
Route identifier.
Type: Integer
Visibility
Route visibility.
Type: Boolean
RouteRepositoryStoreToBlob function.
Stores route repository to binary representation.
Module: RouteRepositoryModule
Result type: TSoapRouteRepositoryStoreToBlob__mcsResult
Parameters:SearchAddCityToSelection function.
Adds found city to session selection. Name of the city will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic information about boundaries and middle point of the city.
Module: SearchModule
Result type: TSoapSearchAddCityToSelection__mcsResult
Parameters:CityNum
The number of city being an index in the list created in the session context by SearchSelectCities function. Value 0 is the first index.
Type: Integer
SearchAddObjectToSelection function.
Adds found map element to session selection. Name and area of the element will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic information about boundaries and middle point of the element.
Module: SearchModule
Result type: TSoapSearchAddObjectToSelection__mcsResult
Parameters:ObjectNum
The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index.
Type: Integer
SearchAddStreetCrossingToSelection function.
Searches for a crossing for two streets and adds it to session selection. Found crossing will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic coordinates of the crossing point.
Module: SearchModule
Result type: TSoapSearchAddStreetCrossingToSelection__mcsResult
Parameters:StreetHandleA
A handle to the first street. The handle to a street found by SearchSelectItems or SearchSelectItemsEx function should be get using SearchGetStreetHandle function.
Type: Integer
StreetHandleB
A handle to the second street. The handle to a street found by SearchSelectItems or SearchSelectItemsEx function should be get using SearchGetStreetHandle function.
Type: Integer
SearchAddStreetWithNumToSelection function.
Searches for the given building number on a street and adds it to session selection. Found position will be marked out on all maps generated for the session. All selections are removed by ClearMapSelection function. Function returns geographic coordinates of found point.
Module: SearchModule
Result type: TSoapSearchAddStreetWithNumToSelection__mcsResult
Parameters:StreetNum
The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index. The element must be of kind "roads".
Type: Integer
Numeration
Building number to be found.
Type: WideString
SearchGetCityList function.
Returns a part of list of cities found by SearchSelectCities function. In addition names and abbreviations of administrative regions are returned for each city.
Module: SearchModule
Result type: TSoapSearchGetCityList__mcsResult
Parameters:First
A start index of requested part of the city list found and kept in the session search context. Value 0 is the first index.
Type: Integer
Count
Count of requested cities. Function returns at most 100 cities, so if the value is greater, length of resultant lists should be checked.
Type: Integer
SearchGetCityListEx function.
Returns a part of list of cities found by SearchSelectCities function. In addition names and abbreviations of administrative regions are returned for each city.
Module: SearchModule
Result type: TSoapSearchGetCityListEx__mcsResult
Parameters:First
A start index of requested part of the city list found and kept in the session search context. Value 0 is the first index.
Type: Integer
Count
Count of requested cities. Function returns at most 100 cities, so if the value is greater, length of resultant lists should be checked.
Type: Integer
SearchGetCountryList function.
Returns a list of available countries. The first item of the list is empty - it is "any country" entry.
Module: SearchModule
Result type: TSoapSearchGetCountryList__mcsResult
Parameters:SearchGetItemKindList function.
Returns a list of available kinds of searched map elements. The first item of the list is empty - it is "any element kind" entry.
Module: SearchModule
Result type: TSoapSearchGetItemKindList__mcsResult
Parameters:SearchGetItemsList function.
Returns a part of list of map elements found by SearchSelectItems or SearchSelectItemsEx function. In addition indices of corresponding element kinds are returned for each element.
Module: SearchModule
Result type: TSoapSearchGetItemsList__mcsResult
Parameters:First
A start index of requested part of the element list found and kept in the session search context. Value 0 is the first index.
Type: Integer
Count
Count of requested elements. Function returns at most 100 elements, so if the value is greater, length of resultant lists should be checked.
Type: Integer
SearchGetParamValue function.
Returns a value for given parameter of searching stored in the session. List of all supported parameters may be obtained by SearchGetParamValues function.
Module: SearchModule
Result type: TSoapSearchGetParamValue__mcsResult
Parameters:ParamName
Parameter name.
Type: WideString
SearchGetParamValues function.
Returns values for all parameters of searching stored in the
session. Parameter value meanings:
* geocodeparams.firststreetwordpriority -
street word priority:
- 0 = last word priority (default)
- 1 = first
word priority
* geocodeparams.filteroutelems - a list of element kinds to be
filtered out while geocoding (by default the list is empty). The list of
available kinds can be obtained by SearchGetItemKindList
function.
* geocodeparams.attachnumerationtostreet - the coordinates of
numeration points are attached to streets:
- 0 = disabled (default)
- 1
= enabled
Module: SearchModule
Result type: TSoapSearchGetParamValues__mcsResult
Parameters:SearchGetStreetHandle function.
Returns a global identifier (a handle) of a map element being of kind "roads". The handle is fixed for the server session, not only for session search context.
Module: SearchModule
Result type: TSoapSearchGetStreetHandle__mcsResult
Parameters:StreetNum
The number of element being an index in the list created in the session context by SearchSelectItems or SearchSelectItemsEx function. Value 0 is the first index. The element must be of kind "roads".
Type: Integer
SearchInitialize function.
Clears a search context in the given server session and
initializes required search mode of the searching.
Returns value from error
code
table.
Module: SearchModule
Result type: Integer
Parameters:ASCIISearch
This option enables searching without national (diacritic) characters (instead of them equivalent ASCII characters may be used).
Type: Boolean
SearchSelectCities function.
Searches for cities with names cantaining given prefix at the beginning of any word. Cities are searched in the given country. Postal code and administrative regions help in avoiding of ambiguity. The function returns only length of the resultant list. Found cities are kept in the session search context. Search process is case-insensitive.
Module: SearchModule
Result type: TSoapSearchSelectCities__mcsResult
Parameters:Country
The number of country being an index in the list returned by SearchGetCountryList function. Value 0 (the first index) corresponds to "any country".
Type: Integer
Prefix
A phrase being searched at the beginning of city names. The phrase may be empty to obtain all cities.
Type: WideString
ZIP
Postal code.
Type: WideString
Adm1
The name of 2nd level administrative area, i.e. a county.
Type: WideString
Adm2
The name of 3rd level administrative area, i.e. a district.
Type: WideString
Adm3
The name of 4th level administrative area.
Type: WideString
SearchSelectItems function.
Searches for map elements of certain kind with names cantaining given prefix at the beginning of any word. Elements are searched in the given city. The function returns only length of the resultant list. Found elements are kept in the session search context. Search process is case-insensitive.
Module: SearchModule
Result type: TSoapSearchSelectItems__mcsResult
Parameters:CityIndex
The number of city being an index in the list created in the session context by SearchSelectCities function. Value 0 is the first index.
Type: Integer
ItemKindIndex
The number of element kind being an index in the list returned by SearchGetItemKindList function. Value 0 (the first index) corresponds to "any element kind".
Type: Integer
Prefix
A phrase being searched at the beginning of any word of map element names. For elements of some kinds (rivers, lakes, cemeteries, parks) only begginings of whole names are matched. The phrase may be empty to obtain all elements.
Type: WideString
SearchSelectItemsEx function.
Searches for map elements of certain kind with names cantaining given prefix at the beginning of any word. Elements are searched in the given country. The function returns only length of the resultant list. Found elements are kept in the session search context. Search process is case-insensitive.
Module: SearchModule
Result type: TSoapSearchSelectItemsEx__mcsResult
Parameters:Country
The number of country being an index in the list returned by SearchGetCountryList function. Value 0 (the first index) corresponds to "any country".
Type: Integer
ItemKindIndex
The number of element kind being an index in the list returned by SearchGetItemKindList function. Value 0 (the first index) corresponds to "any element kind".
Type: Integer
Prefix
A phrase being searched at the beginning of any word of map element names. For elements of some kinds (rivers, lakes, cemeteries, parks) only begginings of whole names are matched. The phrase may be empty to obtain all elements.
Type: WideString
SearchSetItemsFilter function.
Set the list of map element kinds which are used requesting
the SearchSelectItems
or SearchSelectItemsEx
functions with the ItemKindIndex parameter set to 0. By default all element
kinds are used.
Returns value from error code
table.
Module: SearchModule
Result type: Integer
Parameters:ItemKinds
The list of element kind indices (only indices returned by SearchGetItemKindList function are permitted).
Type: TDynamicIntegerArray
SearchSetParamValue function.
Sets a value for given parameter of searching stored in the
session. List of all supported parameters may be obtained by SearchGetParamValues
function.
Returns value from error code
table.
Module: SearchModule
Result type: Integer
Parameters:ParamName
Parameter name.
Type: WideString
ParamValue
Parameter value.
Type: WideString
ServiceConfigGetServiceParams function.
Returns a service config param list. For future use.
Module: BaseModule
Result type: TSoapServiceConfigGetServiceParams__mcsResult
ServiceConfigSetServiceParam function.
Sets a service config param. For future use.
Returns
value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:ParamName
Parameter name.
Type: WideString
ParamValue
Parameter value.
Type: WideString
SetCurrentViewConfig function.
Sets current session view config.
Returns value from
error code
table.
Module: BaseModule
Result type: Integer
Parameters:ViewConfigName
View config name.
Type: WideString
SetGroupBinaryData function.
Sets an arbitrary binary data for object group identified by
given ID.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
BinaryData
Binary data.
Type: TByteDynArray
SetGroupShapeSettings function.
Sets settings of an object group concerning shape
visualization.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
SetObjectBinaryData function.
Sets an arbitrary binary data for object identified by given
ID.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
BinaryData
Binary data.
Type: TByteDynArray
SetObjectFields function.
Sets a new structure of an object set currently opened
(requires administrative privileges). Any subset of data fileds can be changed.
EditObjectFields
should be invoked before.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:FieldTypes
New types of corresponding object fields. Following values
are supported:
- Character or string field = 0x01
- 16-bit integer field
= 0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field =
0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
-
Date field = 0x09
- Time field = 0x0A
- Date and time field =
0x0B
Type: TDynamicByteArray
FieldSize
New sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.
Type: TDynamicIntegerArray
FieldPrecision
New precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.
Type: TDynamicIntegerArray
FieldInfo
New parameters of corresponding object fields. It is a bit
vector for each field - each bit deals with one parameter:
- key field =
0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
-
indexed field = 0x08
- not null field (value required) = 0x10
Type: TDynamicByteArray
FieldFunctions
Specific features of corresponding object fields. Following
values are supported:
- name (object name being drawn on maps) = 0x01
-
city (for geocoding purposes) = 0x02
- street (for geocoding purposes) =
0x03
- number (for geocoding purposes) = 0x04
- postal code (for
geocoding purposes) = 0x05
- break time (for routing purposes) = 0x0A
-
country (for geocoding purposes) = 0x0F
Type: TDynamicByteArray
SetObjectIDs function.
Filters currently opened object set. Takes into account
objects being results of previous filter performed by the server session on the
object set. Function finds objects with given identifiers or objects, which
haven't got given identifiers. The behaviour depends on value of AllowSelected
parameter.
Returns value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
AllowSelected
Indicates whether given objects should be left (true) or filtered out (false).
Type: Boolean
SetSessionComment function.
Sets session comment.
Returns value from error code
table.
Module: BaseModule
Result type: Integer
Parameters:Comment
Session comment.
Type: WideString
SetSessionLanguageContext function.
Sets session language context.
Returns value from error
code
table.
Module: BaseModule
Result type: Integer
Parameters:ContextIndex
Context level (0-2).
Type: Integer
LanguageName
Language name.
Type: WideString
SetVisibleGroups function.
Sets the visibility on maps for object groups.
Returns
value from error code
table.
Module: ObjectsModule
Result type: Integer
Parameters:TableName
Table name.
Type: WideString
GroupIDs
A list of object group identifiers to be shown on maps. Other object groups in the object set will be hidden. The list of identifiers for all object groups in the object set may be obtained using GetObjectFields function.
Type: TWideStringArray
VehicleRepositoryAddVehicle function.
Defines a new vehicle within the server session's vehicle
repository.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleRepositoryDriverParamsGet function.
Returns current driver parameters of one of the vehicles stored in the session's vehicle repository.
Module: RoutePlannerModule
Result type: TSoapVehicleRepositoryDriverParamsGet__mcsResult
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryDriverParamsSet function.
Sets new driver parameters for given vehicle stored in the
repository replacing present parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryRemoveVehicle function.
Deletes one of the vehicles stored in the session's vehicle
repository.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryRoadParamsGet function.
Returns current road parameters of one of the vehicles stored in the session's vehicle repository.
Module: RoutePlannerModule
Result type: TSoapVehicleRepositoryRoadParamsGet__mcsResult
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryRoadParamsSet function.
Sets new road parameters for given vehicle stored in the
repository replacing present parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryVehicleFetch function.
Fetches existing vehicle with all its parameters from the
repository. The vehicle and its road parameters become current session
parameters for routing.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryVehicleGet function.
Returns parameters of one of the vehicles stored in the session's vehicle repository.
Module: RoutePlannerModule
Result type: TSoapVehicleRepositoryVehicleGet__mcsResult
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryVehicleReplace function.
Raplaces all parameters of one of the vehicle in the
repository with current vehicle and road parameters stored in the session.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryVehiclesClear function.
Deletes all vehicles stored in the session's vehicle
repository.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleRepositoryVehicleSet function.
Sets new vehicle parameters in the session's vehicle
repository replacing present parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryVehiclesGet function.
Returns a list of all vehicles stored in the session's vehicle repository.
Module: RoutePlannerModule
Result type: TSoapVehicleRepositoryVehiclesGet__mcsResult
Parameters:VehicleRepositoryVehiclesSet function.
Sets a new set of vehicles in the vehicle repository.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleRepositoryVehicleViaTollGet function.
Returns current viaTOLL parameters of one of the vehicles stored in the session's vehicle repository.
Module: RoutePlannerModule
Result type: TSoapVehicleRepositoryVehicleViaTollGet__mcsResult
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
VehicleRepositoryVehicleViaTollSet function.
Sets new viaTOLL parameters for given vehicle stored in the
repository replacing present parameters.
Returns value from error code
table.
Module: RoutePlannerModule
Result type: Integer
Parameters:VehicleIndex
Index of vehicle in the repository. It must be a value between 0 and count-1, when count is the number of vehicles.
Type: Integer
TCaptionPosition type.
Mapped to: Byte
TColor type.
Mapped to: Integer
TConnectionString type.
Mapped to: WideString
TGeocodeStatus type.
Mapped to: Byte
TRecordID type.
Mapped to: Integer
TUID type.
Mapped to: WideString
TBlobArray type.
Base type: TByteDynArray
TBooleanArray type.
Base type: Boolean
TByteArray type.
Base type: Byte
TCaptionPositionArray type.
Base type: TCaptionPosition
TDynamicByteArray type.
Base type: Byte
TDynamicIntegerArray type.
Base type: Integer
TFloatArray type.
Base type: Double
TSoapTBooleanArrayArray type.
Base type: TBooleanArray
TSoapTDriveThroughArray type.
Base type: TSoapTDriveThrough
TSoapTFloatArrayArray type.
Base type: TFloatArray
TSoapTLongLatPointArray type.
Base type: TSoapTLongLatPoint
TSoapTLongLatRectArray type.
Base type: TSoapTLongLatRect
TSoapTMapFileEntryArray type.
Base type: TSoapTMapFileEntry
TSoapTPointsArray type.
Base type: TSoapTPoint
TSoapTRectsArray type.
Base type: TSoapTRect
TSoapTRoadParamsArray type.
Base type: TSoapTRoadParams
TSoapTRoadResultsArray type.
Base type: TSoapTRoadResults
TSoapTShipmentsArray type.
Base type: TSoapTShipment
TSoapTTimeWindowsArray type.
Base type: TSoapTTimeWindow
TSoapTVehicleCategoryToShipmentTypeIncompatibilityArray type.
Base type: TSoapTVehicleCategoryToShipmentTypeIncompatibility
TSoapTVehicleEntryArray type.
Base type: TSoapTVehicleEntry
TSoapTWideStringArrayArray type.
Base type: TWideStringArray
TWideStringArray type.
Base type: WideString
TSoapAddGroupIcon__mcsResult class.
Encapsulates all output values for AddGroupIcon function
Properties:NewIconID
Identifier of an icon added.
Type: Integer
TSoapAppendGroup__mcsResult class.
Encapsulates all output values for AppendGroup function
Properties:TSoapAppendObject__mcsResult class.
Encapsulates all output values for AppendObject function
Properties:TSoapAppendObjects__mcsResult class.
Encapsulates all output values for AppendObjects function
Properties:TSoapAuthGetGroup__mcsResult class.
Encapsulates all output values for AuthGetGroup function
Properties:GroupComment
User group comment.
Type: WideString
TSoapAuthGetGroupsList__mcsResult class.
Encapsulates all output values for AuthGetGroupsList function
Properties:TSoapAuthGetUserParamEx__mcsResult class.
Encapsulates all output values for AuthGetUserParamEx function
Properties:ParamValue
Parameter value.
Type: WideString
TSoapAuthGetUserParams__mcsResult class.
Encapsulates all output values for AuthGetUserParams function
Properties:Comment
Comment.
Type: WideString
AccountEnabled
Option of account enabling.
Type: Boolean
TSoapAuthGetUsersList__mcsResult class.
Encapsulates all output values for AuthGetUsersList function
Properties:TSoapCheckUpdate__mcsResult class.
Encapsulates all output values for CheckUpdate function
Properties:ModifiedObjectCount
Number of objects changed. A list of them may be obtained using GetNextResult_UpdatedSet function.
Type: Integer
RemovedObjectCount
Number of objects removed. A list of them may be obtained using GetNextResult_RemovedSet function.
Type: Integer
ModifiedIcons
Indicates whether a list of icons stored into database was changed.
Type: Boolean
TSoapConvertMapToScreen__mcsResult class.
Encapsulates all output values for ConvertMapToScreen function
Properties:ScreenPoints
The resultant list of screen points. Their coordinates may be negative or higher than given image sizes.
Type: TSoapTPointsArray
TSoapConvertScreenToMap__mcsResult class.
Encapsulates all output values for ConvertScreenToMap function
Properties:TSoapCreateSessionID__mcsResult class.
Encapsulates all output values for CreateSessionID function
Properties:TSoapDegeocodeAtPoint__mcsResult class.
Encapsulates all output values for DegeocodeAtPoint function
Properties:AreaName0
Country name.
Type: WideString
AreaName1
The name of 2nd level administrative area, i.e. a county.
Type: WideString
AreaName2
The name of 3rd level administrative area, i.e. a district.
Type: WideString
AreaName3
The name of 4th level administrative area.
Type: WideString
Zip
Postal code.
Type: WideString
InternationalRoad
The list of international roads found.
DatabaseElements
The list of external objects found (saved in the session and placed on a map).
TSoapDegeocodeEx__mcsResult class.
Encapsulates all output values for DegeocodeEx function
Properties:TSoapDegeocodeExWithAttributes__mcsResult class.
Encapsulates all output values for DegeocodeExWithAttributes function
Properties:TSoapDegeocodeGetParamValue__mcsResult class.
Encapsulates all output values for DegeocodeGetParamValue function
Properties:ParamValue
Parameter value.
Type: WideString
TSoapDeleteObjects__mcsResult class.
Encapsulates all output values for DeleteObjects function
Properties:NotDeletedIDs
A list of not deleted objects (locked by other users or not existing).
Type: TWideStringArray
TSoapFilterByObjectShape__mcsResult class.
Encapsulates all output values for FilterByObjectShape function
Properties:Count
Count of objects found.
Type: Integer
TSoapFilterByPoint__mcsResult class.
Encapsulates all output values for FilterByPoint function
Properties:Count
Count of objects found.
Type: Integer
TSoapFilterByRadius__mcsResult class.
Encapsulates all output values for FilterByRadius function
Properties:Count
Count of objects found.
Type: Integer
TSoapFilterByShape__mcsResult class.
Encapsulates all output values for FilterByShape function
Properties:Count
Count of objects found.
Type: Integer
TSoapFilterByText__mcsResult class.
Encapsulates all output values for FilterByText function
Properties:Count
Count of objects found.
Type: Integer
TSoapForwardCalc__mcsResult class.
Encapsulates all output values for ForwardCalc function
Properties:TSoapGeocode__mcsResult class.
Encapsulates all output values for Geocode function
Properties:GeocodeLevel
A list of resultant geocode levels. The geocode level is a
bit vector - each bit deals with one address item:
- country = 0x01
-
2nd level administrative area (county) = 0x02
- 3rd level administrative
area (district) = 0x04
- city = 0x08
- postal code = 0x10
- street =
0x20
- building numeration = 0x40
If an address item was taken into
account while geocoding process, its bit is set to 1. If an address was not
geocoded, the geocode level for it has value 0 (all bits set to 0).
Type: TDynamicByteArray
TSoapGeocodeEx__mcsResult class.
Encapsulates all output values for GeocodeEx function
Properties:GeocodeLevel
A list of resultant geocode levels for proposals found. The
geocode level is a bit vector - each bit deals with one address item:
-
country = 0x01
- 2nd level administrative area (county) = 0x02
- 3rd
level administrative area (district) = 0x04
- city = 0x08
- postal code
= 0x10
- street = 0x20
- building numeration = 0x40
- 4rd level
administrative area (commune) = 0x80
If an address item was taken into
account while geocoding process, its bit is set to 1. If an address was not
geocoded, the geocode level for it has value 0 (all bits set to 0).
Type: TDynamicByteArray
BoundingRects
Geographic coordinates of the rectangles bounding objects found.
Type: TSoapTLongLatRectArray
TSoapGetActiveSessions__mcsResult class.
Encapsulates all output values for GetActiveSessions function
Properties:TSoapGetAggregatedObjects__mcsResult class.
Encapsulates all output values for GetAggregatedObjects function
Properties:Aggregated
A list of informations of object aggregation possibility - whether given objects have got any shapes tied with them (in case of an empty list of identifiers returned for some object, to distinguish between objects without shapes and objects with shapes but without objects contained).
Type: TBooleanArray
TSoapGetAggregatedObjectShapes__mcsResult class.
Encapsulates all output values for GetAggregatedObjectShapes function
Properties:TSoapGetAvailableIconFormats__mcsResult class.
Encapsulates all output values for GetAvailableIconFormats function
Properties:TSoapGetAvailableImageFormats__mcsResult class.
Encapsulates all output values for GetAvailableImageFormats function
Properties:TSoapGetAvailableMapFiles__mcsResult class.
Encapsulates all output values for GetAvailableMapFiles function
Properties:TSoapGetCurrentSessionCount__mcsResult class.
Encapsulates all output values for GetCurrentSessionCount function
Properties:SessionCount
Resultant number of sessions.
Type: Integer
TSoapGetCurrentViewConfig__mcsResult class.
Encapsulates all output values for GetCurrentViewConfig function
Properties:ViewConfigName
Current view config name.
Type: WideString
TSoapGetDatabaseList__mcsResult class.
Encapsulates all output values for GetDatabaseList function
Properties:TSoapGetDatabaseTableList__mcsResult class.
Encapsulates all output values for GetDatabaseTableList function
Properties:TSoapGetDefaultLayers__mcsResult class.
Encapsulates all output values for GetDefaultLayers function
Properties:TSoapGetDegeocodeLayers__mcsResult class.
Encapsulates all output values for GetDegeocodeLayers function
Properties:TSoapGetGroupBinaryData__mcsResult class.
Encapsulates all output values for GetGroupBinaryData function
Properties:BinaryData
Binary data.
Type: TByteDynArray
TSoapGetGroupIcon__mcsResult class.
Encapsulates all output values for GetGroupIcon function
Properties:GroupIcon
Resultant icon transferred as a byte stream.
Type: TByteDynArray
TSoapGetGroupIcons__mcsResult class.
Encapsulates all output values for GetGroupIcons function
Properties:TSoapGetGroupSettings__mcsResult class.
Encapsulates all output values for GetGroupSettings function
Properties:VisibleFields
Names of fields essential for an object group - other fields in object set are not important for the object group.
Type: TWideStringArray
TSoapGetGroupShapeSettings__mcsResult class.
Encapsulates all output values for GetGroupShapeSettings function
Properties:TSoapGetLoadedMapsRegion__mcsResult class.
Encapsulates all output values for GetLoadedMapsRegion function
Properties:TSoapGetMapModules__mcsResult class.
Encapsulates all output values for GetMapModules function
Properties:TSoapGetMapPointLength__mcsResult class.
Encapsulates all output values for GetMapPointLength function
Properties:Distance
Resultant distance (in meters).
Type: Double
TSoapGetMaxSessionsCount__mcsResult class.
Encapsulates all output values for GetMaxSessionsCount function
Properties:SessionCount
Resultant number of sessions.
Type: Integer
TSoapGetModifiedFields__mcsResult class.
Encapsulates all output values for GetModifiedFields function
Properties:TSoapGetNextResult_FieldSet__mcsResult class.
Encapsulates all output values for GetNextResult_FieldSet function
Properties:TSoapGetNextResult_IDSet__mcsResult class.
Encapsulates all output values for GetNextResult_IDSet function
Properties:TSoapGetNextResult_PositionSet__mcsResult class.
Encapsulates all output values for GetNextResult_PositionSet function
Properties:CaptionPositions
Positions of object names being drawn on maps nearby its
icons. The position is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Type: TCaptionPositionArray
TSoapGetNextResult_RemovedSet__mcsResult class.
Encapsulates all output values for GetNextResult_RemovedSet function
Properties:TSoapGetNextResult_Set__mcsResult class.
Encapsulates all output values for GetNextResult_Set function
Properties:CaptionPositions
Positions of object names being drawn on maps nearby its
icons. The position is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Type: TCaptionPositionArray
TSoapGetNextResult_UpdatedSet__mcsResult class.
Encapsulates all output values for GetNextResult_UpdatedSet function
Properties:CaptionPositions
Positions of object names being drawn on maps nearby its
icons. The position is the alignment of object name with reference to its icon.
Supported values are:
- bottom-right = 0x00
- bottom = 0x01
-
bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Type: TCaptionPositionArray
TSoapGetObject__mcsResult class.
Encapsulates all output values for GetObject function
Properties:CaptionPosition
Position of object name being drawn on maps nearby its icon.
It is the alignment of object name with reference to its icon. Supported values
are:
- bottom-right = 0x00
- bottom = 0x01
- bottom-left = 0x02
- left = 0x03
- top-left = 0x04
- top = 0x05
- top-right = 0x06
- right = 0x07
Type: TCaptionPosition
TSoapGetObjectAggregates__mcsResult class.
Encapsulates all output values for GetObjectAggregates function
Properties:FieldSum
A list of sum values for requested fields. Empty strings are returned for non-numeric fields.
Type: TWideStringArray
FieldAvg
A list of average values for requested fields. Empty strings are returned for non-numeric fields.
Type: TWideStringArray
TSoapGetObjectBinaryData__mcsResult class.
Encapsulates all output values for GetObjectBinaryData function
Properties:BinaryData
Binary data.
Type: TByteDynArray
TSoapGetObjectCircles__mcsResult class.
Encapsulates all output values for GetObjectCircles function
Properties:TSoapGetObjectCount__mcsResult class.
Encapsulates all output values for GetObjectCount function
Properties:RecordCount
A count of objects available.
Type: Integer
TSoapGetObjectEllipses__mcsResult class.
Encapsulates all output values for GetObjectEllipses function
Properties:TSoapGetObjectFields__mcsResult class.
Encapsulates all output values for GetObjectFields function
Properties:FieldTypes
Types of corresponding object fields. Following values are
supported:
- Character or string field = 0x01
- 16-bit integer field =
0x02
- 32-bit integer field = 0x03
- 16-bit unsigned integer field =
0x04
- Boolean field = 0x05
- Floating-point numeric field = 0x06
-
Date field = 0x09
- Time field = 0x0A
- Date and time field =
0x0B
Type: TDynamicByteArray
FieldSize
Sizes of corresponding object fields. Size is the maximum number of characters in the string field. For all other field types, size value is always 0.
Type: TDynamicIntegerArray
FieldPrecision
Precision of corresponding object fields. It is used in formatting the value in a floating-point fields only and is the number of digits beyond the decimal point. For all other field types, precision value is always 0.
Type: TDynamicIntegerArray
FieldInfo
Parameters of corresponding object fields. It is a bit
vector for each field - each bit deals with one parameter:
- key field =
0x01
- link field (hyperlink values) = 0x02
- hidden field = 0x04
-
indexed field = 0x08
- not null field (value required) = 0x10
Type: TDynamicByteArray
FieldFunctions
Specific features of corresponding object fields. Following
values are supported:
- name (object name being drawn on maps) = 0x01
-
city (for geocoding purposes) = 0x02
- street (for geocoding purposes) =
0x03
- number (for geocoding purposes) = 0x04
- postal code (for
geocoding purposes) = 0x05
- break time (for routing purposes) = 0x0A
-
country (for geocoding purposes) = 0x0F
Type: TDynamicByteArray
GroupIDs
A list of unique identifiers of all object groups in the object set.
Type: TWideStringArray
TSoapGetObjectPolygons__mcsResult class.
Encapsulates all output values for GetObjectPolygons function
Properties:TSoapGetObjectPolylines__mcsResult class.
Encapsulates all output values for GetObjectPolylines function
Properties:TSoapGetObjectRectangles__mcsResult class.
Encapsulates all output values for GetObjectRectangles function
Properties:TSoapGetProjections__mcsResult class.
Encapsulates all output values for GetProjections function
Properties:TSoapGetRemovedFields__mcsResult class.
Encapsulates all output values for GetRemovedFields function
Properties:TSoapGetScreenPointLength__mcsResult class.
Encapsulates all output values for GetScreenPointLength function
Properties:Distance
Resultant distance (in meters).
Type: Double
TSoapGetServerVersion__mcsResult class.
Encapsulates all output values for GetServerVersion function
Properties:ServerVersion
Server version.
Type: WideString
TSoapGetSessionComment__mcsResult class.
Encapsulates all output values for GetSessionComment function
Properties:Comment
Session comment.
Type: WideString
TSoapGetSessionLanguageContext__mcsResult class.
Encapsulates all output values for GetSessionLanguageContext function
Properties:LanguageName
Language name.
Type: WideString
TSoapGetSessionLifetimeSeconds__mcsResult class.
Encapsulates all output values for GetSessionLifetimeSeconds function
Properties:SessionLifetime
Resultant time.
Type: Integer
TSoapGetTiledMapLayers__mcsResult class.
Encapsulates all output values for GetTiledMapLayers function
Properties:TSoapGetViewConfigList__mcsResult class.
Encapsulates all output values for GetViewConfigList function
Properties:TSoapGetVisibleGroups__mcsResult class.
Encapsulates all output values for GetVisibleGroups function
Properties:TSoapInverseCalc__mcsResult class.
Encapsulates all output values for InverseCalc function
Properties:Length
Resultant distance (in meters).
Type: Double
Azimuth12
Resultant azimuth from the start to the stop point. It is an angle in degrees between 0 and 360 counterclockwise.
Type: Double
Azimuth21
Resultant azimuth from the stop to the start point. It is an angle in degrees between 0 and 360 counterclockwise.
Type: Double
TSoapLocalizeGetObjectVisibility__mcsResult class.
Encapsulates all output values for LocalizeGetObjectVisibility function
Properties:ObjectVisibility
A list of localized objects visibility informations. Length of the list equals the number of objects in the localized objects collection.
Type: TBooleanArray
TSoapLocalizeIconGet__mcsResult class.
Encapsulates all output values for LocalizeIconGet function
Properties:IconData
An icon transferred as a byte stream.
Type: TByteDynArray
TSoapLocalizeIconGetCount__mcsResult class.
Encapsulates all output values for LocalizeIconGetCount function
Properties:Count
The number of icons in a collection.
Type: Integer
TSoapLocalizeIconIDToItemIndex__mcsResult class.
Encapsulates all output values for LocalizeIconIDToItemIndex function
Properties:ItemIndex
Index of an icon in the collection. It is a value between 0 and count-1, when count may be obtained using LocalizeIconGetCount function.
Type: Integer
TSoapLocalizeNumFieldsGet__mcsResult class.
Encapsulates all output values for LocalizeNumFieldsGet function
Properties:Name
Field name.
Type: WideString
ShowOnInfo
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Type: Boolean
TSoapLocalizeNumFieldsGetCount__mcsResult class.
Encapsulates all output values for LocalizeNumFieldsGetCount function
Properties:Count
The number of fields in a collection.
Type: Integer
TSoapLocalizeObjectEntityIDToItemIndex__mcsResult class.
Encapsulates all output values for LocalizeObjectEntityIDToItemIndex function
Properties:ItemIndex
Index of an object in the collection. It is a value between 0 and count-1, when count may be obtained using LocalizeObjectGetCount function.
Type: Integer
TSoapLocalizeObjectGet__mcsResult class.
Encapsulates all output values for LocalizeObjectGet function
Properties:EntityID
The unique object identifier.
Type: Integer
Name
Object name displayed by the last position of an object on the map, providing the ShowName option is active.
Type: WideString
ShowName
Information on whether to display the name by the last position of an object on the map.
Type: Boolean
IconID
A unique identifier of icon saved in the icons collection in the server session.
Type: Integer
ShowIcon
Information on whether to display the icon by the last position of an object on the map.
Type: Boolean
IconColor
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It is a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
PathColor
The color of the track created by the object positions. It is a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
PathWidth
The width of the track created by the object positions (measured in pixels).
Type: Integer
Size
The size of the position marker in the track, measured in pixels.
Type: Integer
RemovePreviousPositions
Information on whether to delete the previous object positions while localizing new positions of the object.
Type: Boolean
PointsConnected
Information on whether to connect the object positions into a track.
Type: Boolean
TSoapLocalizeObjectGetCount__mcsResult class.
Encapsulates all output values for LocalizeObjectGetCount function
Properties:Count
The number of objects in a collection.
Type: Integer
TSoapLocalizeObjectPositionGet__mcsResult class.
Encapsulates all output values for LocalizeObjectPositionGet function
Properties:NumFields
Values of all numeric fields contained in the collection saved in the server session.
Type: TFloatArray
StrFields
Values of all string fields contained in the collection saved in the server session.
Type: TWideStringArray
Time
Time (in the GMT time zone) of the position (number of days since 30-12-1899 12:00 AM).
Type: Double
Description
The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.
Type: WideString
ShowDescription
Information on whether to display the description of the position of the object on the map.
Type: Boolean
ShowName
Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).
Type: Boolean
IconID
A unique identifier of icon saved in the icons collection in the server session.
Type: Integer
ShowIcon
Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).
Type: Boolean
IconColor
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It is a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
TSoapLocalizeObjectPositionGetCount__mcsResult class.
Encapsulates all output values for LocalizeObjectPositionGetCount function
Properties:Count
The number of object positions of the localized object.
Type: Integer
TSoapLocalizeStrFieldsGet__mcsResult class.
Encapsulates all output values for LocalizeStrFieldsGet function
Properties:Name
Field name.
Type: WideString
ShowOnInfo
Information on whether the field values are returned by DegeocodeAtPoint function as a part of localized object description.
Type: Boolean
TSoapLocalizeStrFieldsGetCount__mcsResult class.
Encapsulates all output values for LocalizeStrFieldsGetCount function
Properties:Count
The number of fields in a collection.
Type: Integer
TSoapMapBaseConnect__mcsResult class.
Encapsulates all output values for MapBaseConnect function
Properties:AccessLevel
Indicates whether logged user has permissions to change data (0 = administrative privileges, 1 = editing, 2 = read only access).
Type: Integer
TSoapMapBaseStoreToBlob__mcsResult class.
Encapsulates all output values for MapBaseStoreToBlob function
Properties:BinaryData
A database content.
Type: TByteDynArray
TSoapMultiGeocodeEx__mcsResult class.
Encapsulates all output values for MultiGeocodeEx function
Properties:TSoapPostObjects__mcsResult class.
Encapsulates all output values for PostObjects function
Properties:NotPostedIDs
A list of not posted objects (locked by other users or not existing).
Type: TWideStringArray
TSoapRenderMapOnHWNDByPoint__mcsResult class.
Encapsulates all output values for RenderMapOnHWNDByPoint function
Properties:BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderMapOnHWNDByPointWithCopyright__mcsResult class.
Encapsulates all output values for RenderMapOnHWNDByPointWithCopyright function
Properties:BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderMapOnHWNDByRect__mcsResult class.
Encapsulates all output values for RenderMapOnHWNDByRect function
Properties:MapAltitude
Zoom of the resultant map being an altitude expressed in meters over sea level.
Type: Double
BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderMapOnHWNDByRectWithCopyright__mcsResult class.
Encapsulates all output values for RenderMapOnHWNDByRectWithCopyright function
Properties:MapAltitude
Zoom of the resultant map being an altitude expressed in meters over sea level.
Type: Double
BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderMapOnImageByPoint__mcsResult class.
Encapsulates all output values for RenderMapOnImageByPoint function
Properties:BitmapImage
The resultant image transferred as a byte stream.
Type: TByteDynArray
BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderMapOnImageByPointWithCopyright__mcsResult class.
Encapsulates all output values for RenderMapOnImageByPointWithCopyright function
Properties:BitmapImage
The resultant image transferred as a byte stream.
Type: TByteDynArray
BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderMapOnImageByRect__mcsResult class.
Encapsulates all output values for RenderMapOnImageByRect function
Properties:BitmapImage
The resultant image transferred as a byte stream.
Type: TByteDynArray
MapAltitude
Zoom of the resultant map being an altitude expressed in meters over sea level.
Type: Double
BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderMapOnImageByRectWithCopyright__mcsResult class.
Encapsulates all output values for RenderMapOnImageByRectWithCopyright function
Properties:BitmapImage
The resultant image transferred as a byte stream.
Type: TByteDynArray
MapAltitude
Zoom of the resultant map being an altitude expressed in meters over sea level.
Type: Double
BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderSplitMapOnImageByPoint__mcsResult class.
Encapsulates all output values for RenderSplitMapOnImageByPoint function
Properties:BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderSplitMapOnImageByPointWithCopyright__mcsResult class.
Encapsulates all output values for RenderSplitMapOnImageByPointWithCopyright function
Properties:BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderSplitMapOnImageByRect__mcsResult class.
Encapsulates all output values for RenderSplitMapOnImageByRect function
Properties:MapAltitude
Zoom of the resultant map being an altitude expressed in meters over sea level.
Type: Double
BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderSplitMapOnImageByRectWithCopyright__mcsResult class.
Encapsulates all output values for RenderSplitMapOnImageByRectWithCopyright function
Properties:MapAltitude
Zoom of the resultant map being an altitude expressed in meters over sea level.
Type: Double
BitmapRightUpCorner
Geographic coordinates of right-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapRightDownCorner
Geographic coordinates of right-down point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftUpCorner
Geographic coordinates of left-up point of the resultant map.
Type: TSoapTLongLatPoint
BitmapLeftDownCorner
Geographic coordinates of left-down point of the resultant map.
Type: TSoapTLongLatPoint
TSoapRenderTiledMap__mcsResult class.
Encapsulates all output values for RenderTiledMap function
Properties:TilesX
X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Type: Integer
TilesY
Y-dimension (number of columns) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Type: Integer
TSoapRenderTiledMapEx__mcsResult class.
Encapsulates all output values for RenderTiledMapEx function
Properties:BitmapImagesPresent
List of presence of subseqent images within the resultant images.
Type: TBooleanArray
TilesX
X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Type: Integer
TilesY
Y-dimension (number of columns) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Type: Integer
TSoapRenderTiledMapWithCopyright__mcsResult class.
Encapsulates all output values for RenderTiledMapWithCopyright function
Properties:TilesX
X-dimension (number of rows) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Type: Integer
TilesY
Y-dimension (number of columns) of the resultant tiles matrix - 1 for the zoom 0, 2 for 1, 4 for 2 and 8 for other zoom values.
Type: Integer
TSoapRouteAttributesAddAlongRouteAttribute__mcsResult class.
Encapsulates all output values for RouteAttributesAddAlongRouteAttribute function
Properties:AttributeID
Auto-generated difficulty identifier. Essential if GenerateID option was set to true.
Type: Integer
Representation
All points of generated polyline (if ReturnRepresentation option was set to true).
Type: TSoapTLongLatPointArray
TSoapRouteAttributesAddLineAttribute__mcsResult class.
Encapsulates all output values for RouteAttributesAddLineAttribute function
Properties:AttributeID
Auto-generated difficulty identifier. Essential if GenerateID option was set to true.
Type: Integer
TSoapRouteAttributesAddPointAttribute__mcsResult class.
Encapsulates all output values for RouteAttributesAddPointAttribute function
Properties:AttributeID
Auto-generated difficulty identifier. Essential if GenerateID option was set to true.
Type: Integer
TSoapRouteAttributesAddPolygonAttribute__mcsResult class.
Encapsulates all output values for RouteAttributesAddPolygonAttribute function
Properties:AttributeID
Auto-generated difficulty identifier. Essential if GenerateID option was set to true.
Type: Integer
TSoapRouteAttributesGetAttributesProviderList__mcsResult class.
Encapsulates all output values for RouteAttributesGetAttributesProviderList function
Properties:TSoapRouteAttributesGetDataProviderActions__mcsResult class.
Encapsulates all output values for RouteAttributesGetDataProviderActions function
Properties:TSoapRouteAttributesGetDataProviderParams__mcsResult class.
Encapsulates all output values for RouteAttributesGetDataProviderParams function
Properties:TSoapRouteAttributesGetPassedAttributesList__mcsResult class.
Encapsulates all output values for RouteAttributesGetPassedAttributesList function
Properties:VisitedAttributes
List of the difficulties which were taken into account but haven't influenced on the last calculated route.
BlockedAttributes
List of the difficulties which have influenced on the last calculated route.
TSoapRouteAttributesGetRouteAttribute__mcsResult class.
Encapsulates all output values for RouteAttributesGetRouteAttribute function
Properties:TSoapRouteAttributesGetRouteAttributes__mcsResult class.
Encapsulates all output values for RouteAttributesGetRouteAttributes function
Properties:TSoapRouteAttributesGetRouteAttributeWithGeometry__mcsResult class.
Encapsulates all output values for RouteAttributesGetRouteAttributeWithGeometry function
Properties:GeometryKind
Difficulty geometry kind:
- point = 0x00
-
road-along placed polyline = 0x01
- polyline = 0x02
- polygon = 0x03
- none = 0x04
Type: Integer
Geometry
A list of all difficulty points (number of point is dependent on difficulty geometry kind).
Type: TSoapTLongLatPointArray
TSoapRouteAttributesGetSubscribedProvidersList__mcsResult class.
Encapsulates all output values for RouteAttributesGetSubscribedProvidersList function
Properties:TSoapRouteAttributesModifyAlongRouteAttribute__mcsResult class.
Encapsulates all output values for RouteAttributesModifyAlongRouteAttribute function
Properties:Representation
All points of generated polyline (if ReturnRepresentation option was set to true).
Type: TSoapTLongLatPointArray
TSoapRouteAttributesStoreToBlob__mcsResult class.
Encapsulates all output values for RouteAttributesStoreToBlob function
Properties:BinaryRepresentation
Returned binary representation of routing difficulties.
Type: TByteDynArray
TSoapRouteOptimizerGetDepotEntry__mcsResult class.
Encapsulates all output values for RouteOptimizerGetDepotEntry function
Properties:DepotEntryIndex
Index of the depot waypoint. It is a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
TSoapRouteOptimizerGetEntryDeliveryShipments__mcsResult class.
Encapsulates all output values for RouteOptimizerGetEntryDeliveryShipments function
Properties:DeliveryShipments
Resultant list of delivery shipments defined for a waypoint.
Type: TSoapTShipmentsArray
TSoapRouteOptimizerGetEntryPickupShipments__mcsResult class.
Encapsulates all output values for RouteOptimizerGetEntryPickupShipments function
Properties:PickupShipments
Resultant list of pickup shipments defined for a waypoint.
Type: TSoapTShipmentsArray
TSoapRouteOptimizerGetEntryShipmentDeliveryPickupTimes__mcsResult class.
Encapsulates all output values for RouteOptimizerGetEntryShipmentDeliveryPickupTimes function
Properties:DeliveryTime
Time of shipment delivery (in minutes).
Type: Integer
PickupTime
Time of shipment pickup (in minutes).
Type: Integer
TSoapRouteOptimizerGetEntryTimeWindows__mcsResult class.
Encapsulates all output values for RouteOptimizerGetEntryTimeWindows function
Properties:TSoapRouteOptimizerOptimizeRoute__mcsResult class.
Encapsulates all output values for RouteOptimizerOptimizeRoute function
Properties:CyclePoints
Properties of the waypoint entries after optimization process.
TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
RouteRepresentation
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Type: TSoapTLongLatPointArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRouteOptimizerShipmentTypesGet__mcsResult class.
Encapsulates all output values for RouteOptimizerShipmentTypesGet function
Properties:TSoapRouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet__mcsResult class.
Encapsulates all output values for RouteOptimizerShipmentTypeToShipmentTypeIncompatibilityGet function
Properties:ShipmentTypeToShipmentTypeIncompatibility
Resultant list of incompatibility pairs.
TSoapRouteOptimizerSimpleOptimizeRoute__mcsResult class.
Encapsulates all output values for RouteOptimizerSimpleOptimizeRoute function
Properties:CyclePoints
Properties of the waypoint entries after optimization process.
TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
RouteRepresentation
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Type: TSoapTLongLatPointArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRouteOptimizerSolveProblem__mcsResult class.
Encapsulates all output values for RouteOptimizerSolveProblem function
Properties:SolutionCost
Total cost of all routes in hundreth parts of the main currency.
Type: Integer
ShipmentMoves
A list of shipment events for all routes.
ShipmentDeliveries
A list of all resultant delivery shipment actions.
ShipmentPickups
A list of all resultant pickup shipment actions.
TSoapRouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet__mcsResult class.
Encapsulates all output values for RouteOptimizerVehicleCategoryToShipmentTypeIncompatibilityGet function
Properties:VehicleCategoryToShipmentTypeIncompatibility
Resultant list of incompatibility pairs.
Type: TSoapTVehicleCategoryToShipmentTypeIncompatibilityArray
TSoapRoutePlannerCalculateAlternativeRoutesAndStore__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateAlternativeRoutesAndStore function
Properties:ResultCount
Number of resultant routes.
Type: Integer
TotalRouteTimes
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRectArray
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerCalculatePointDistanceFromRoute__mcsResult class.
Encapsulates all output values for RoutePlannerCalculatePointDistanceFromRoute function
Properties:DistanceFromRoute
Resultant list of calculated distances (in meters). If calculated distance is greater then MaxLength, it will equal 0.
Type: TFloatArray
TSoapRoutePlannerCalculatePointWithinRouteBuffer__mcsResult class.
Encapsulates all output values for RoutePlannerCalculatePointWithinRouteBuffer function
Properties:TSoapRoutePlannerCalculateRoute__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateRoute function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
RouteRepresentation
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Type: TSoapTLongLatPointArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerCalculateRouteDistanceMatrix__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateRouteDistanceMatrix function
Properties:TotalRouteTimes
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TSoapTFloatArrayArray
UnreachableEntry
Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerCalculateRouteFromGPSTrack__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateRouteFromGPSTrack function
Properties:RouteRepresentation
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Type: TSoapTLongLatPointArray
TotalRouteLength
Total route length in meters.
Type: Double
TSoapRoutePlannerCalculateRoutesWithMultipleDepots__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateRoutesWithMultipleDepots function
Properties:DepotAssigments
A list of start point numbers choosen for calculated routes (beginning with 0).
Type: TDynamicIntegerArray
TotalRouteTimes
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
UnreachableEntry
Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerCalculateRoutesWithMultipleDepotsAndStore__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateRoutesWithMultipleDepotsAndStore function
Properties:DepotAssigments
A list of start point numbers choosen for calculated routes (beginning with 0).
Type: TDynamicIntegerArray
TotalRouteTimes
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
UnreachableEntry
Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerCalculateRoutesWithSingleDepot__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateRoutesWithSingleDepot function
Properties:TotalRouteTimes
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
UnreachableEntry
Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerCalculateRoutesWithSingleDepotAndStore__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateRoutesWithSingleDepotAndStore function
Properties:TotalRouteTimes
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
UnreachableEntry
Index of first unreachable destination waypoint (essential when at least one route could not be calculated). The first destination waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerCalculateRouteWithBinaryResult__mcsResult class.
Encapsulates all output values for RoutePlannerCalculateRouteWithBinaryResult function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
BinaryRouteRepresentation
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.
Type: TByteDynArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of user or automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerDriverParamsGet__mcsResult class.
Encapsulates all output values for RoutePlannerDriverParamsGet function
Properties:TSoapRoutePlannerEntriesAdd__mcsResult class.
Encapsulates all output values for RoutePlannerEntriesAdd function
Properties:RoutePlanEntriesDescription
Automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road.
Type: TWideStringArray
TSoapRoutePlannerEntriesGet__mcsResult class.
Encapsulates all output values for RoutePlannerEntriesGet function
Properties:RoutePlanVisitTimes
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
TSoapRoutePlannerEntriesGetCount__mcsResult class.
Encapsulates all output values for RoutePlannerEntriesGetCount function
Properties:Count
A count of waypoints.
Type: Integer
TSoapRoutePlannerEntriesGetWithSnapPoints__mcsResult class.
Encapsulates all output values for RoutePlannerEntriesGetWithSnapPoints function
Properties:RoutePlanEntriesSnapPoints
A list of geographic coordinates of waypoint's snap points.
Type: TSoapTLongLatPointArray
RoutePlanVisitTimes
A list of visit times for corresponding waypoints. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
TSoapRoutePlannerEntriesSet__mcsResult class.
Encapsulates all output values for RoutePlannerEntriesSet function
Properties:RoutePlanEntriesDescription
Automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road.
Type: TWideStringArray
TSoapRoutePlannerEntryAdd__mcsResult class.
Encapsulates all output values for RoutePlannerEntryAdd function
Properties:RoutePlanEntryDescription
Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.
Type: WideString
TSoapRoutePlannerEntryGet__mcsResult class.
Encapsulates all output values for RoutePlannerEntryGet function
Properties:RoutePlanVisitTime
Visit time for a waypoint. Value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
RoutePlanEntryDescription
Waypoint description.
Type: WideString
TSoapRoutePlannerEntryInsert__mcsResult class.
Encapsulates all output values for RoutePlannerEntryInsert function
Properties:RoutePlanEntryDescription
Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.
Type: WideString
TSoapRoutePlannerEntrySet__mcsResult class.
Encapsulates all output values for RoutePlannerEntrySet function
Properties:RoutePlanEntryDescription
Automatic generated geographical waypoint descripton - information on waypoint nearest city, street or road.
Type: WideString
TSoapRoutePlannerGetAvailableRoadTypes__mcsResult class.
Encapsulates all output values for RoutePlannerGetAvailableRoadTypes function
Properties:TSoapRoutePlannerGetParamValue__mcsResult class.
Encapsulates all output values for RoutePlannerGetParamValue function
Properties:ParamValue
Parameter value.
Type: WideString
TSoapRoutePlannerGetParamValues__mcsResult class.
Encapsulates all output values for RoutePlannerGetParamValues function
Properties:TSoapRoutePlannerGetRouteItinerary__mcsResult class.
Encapsulates all output values for RoutePlannerGetRouteItinerary function
Properties:RouteItinerary
Resultant route itinerary - a list of all route events.
TSoapRoutePlannerGetRouteLogisticTOLLSummary__mcsResult class.
Encapsulates all output values for RoutePlannerGetRouteLogisticTOLLSummary function
Properties:LogisticTOLLRoadResults
Toll costs divided into separated countries.
TSoapRoutePlannerGetRouteRepresentation__mcsResult class.
Encapsulates all output values for RoutePlannerGetRouteRepresentation function
Properties:RouteRepresentation
Geographic route representation - a list of all points forming a route.
Type: TSoapTLongLatPointArray
TSoapRoutePlannerGetRouteRepresentationWithBinaryResult__mcsResult class.
Encapsulates all output values for RoutePlannerGetRouteRepresentationWithBinaryResult function
Properties:BinaryRouteRepresentation
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers).
Type: TByteDynArray
TSoapRoutePlannerGetRouteSummary__mcsResult class.
Encapsulates all output values for RoutePlannerGetRouteSummary function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
TSoapRoutePlannerGetRouteViaTollSummary__mcsResult class.
Encapsulates all output values for RoutePlannerGetRouteViaTollSummary function
Properties:ViaTollRoadResults
viaTOLL results divided into separated road types.
TSoapRoutePlannerRoadParamsGet__mcsResult class.
Encapsulates all output values for RoutePlannerRoadParamsGet function
Properties:TSoapRoutePlannerRoadViaTollParamsGet__mcsResult class.
Encapsulates all output values for RoutePlannerRoadViaTollParamsGet function
Properties:TSoapRoutePlannerRouteStoreToBlob__mcsResult class.
Encapsulates all output values for RoutePlannerRouteStoreToBlob function
Properties:BinaryRepresentation
Returned binary representation.
Type: TByteDynArray
TSoapRoutePlannerSimpleCalculateAlternativeRoutesAndStore__mcsResult class.
Encapsulates all output values for RoutePlannerSimpleCalculateAlternativeRoutesAndStore function
Properties:ResultCount
Number of resultant routes.
Type: Integer
TotalRouteTimes
Total duration time for each calculated route, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: TFloatArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRectArray
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerSimpleCalculateRoute__mcsResult class.
Encapsulates all output values for RoutePlannerSimpleCalculateRoute function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
RouteRepresentation
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Type: TSoapTLongLatPointArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerSimpleCalculateRoute2__mcsResult class.
Encapsulates all output values for RoutePlannerSimpleCalculateRoute2 function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TotalViaTollLength
Total viaTOLL segments' length in meters.
Type: Double
TotalViaTollCost
Total viaTOLL cost.
Type: Double
TotalChargeRoadLength
Total length of charged segments (in meters).
Type: Double
ViaTollRoadResults
viaTOLL results divided into separated road types.
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
RouteRepresentation
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Type: TSoapTLongLatPointArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerSimpleCalculateRoute2WithBinaryResult__mcsResult class.
Encapsulates all output values for RoutePlannerSimpleCalculateRoute2WithBinaryResult function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TotalViaTollLength
Total viaTOLL segments' length in meters.
Type: Double
TotalViaTollCost
Total viaTOLL cost.
Type: Double
TotalChargeRoadLength
Total length of charged segments (in meters).
Type: Double
ViaTollRoadResults
viaTOLL results divided into separated road types.
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
BinaryRouteRepresentation
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.
Type: TByteDynArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerSimpleCalculateRoute3__mcsResult class.
Encapsulates all output values for RoutePlannerSimpleCalculateRoute3 function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TotalViaTollLength
Total viaTOLL segments' length in meters.
Type: Double
TotalViaTollCost
Total viaTOLL cost.
Type: Double
TotalChargeRoadLength
Total length of charged segments (in meters).
Type: Double
ViaTollRoadResults
viaTOLL results divided into separated road types.
LogisticTOLLResults
Toll costs divided into separated countries.
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
RouteRepresentation
Geographic route representation - a list of all points forming a route. Returned if option ReturnRouteRepresentation is set to True.
Type: TSoapTLongLatPointArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerSimpleCalculateRoute3WithBinaryResult__mcsResult class.
Encapsulates all output values for RoutePlannerSimpleCalculateRoute3WithBinaryResult function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TotalViaTollLength
Total viaTOLL segments' length in meters.
Type: Double
TotalViaTollCost
Total viaTOLL cost.
Type: Double
TotalChargeRoadLength
Total length of charged segments (in meters).
Type: Double
ViaTollRoadResults
viaTOLL results divided into separated road types.
LogisticTOLLResults
Toll costs divided into separated countries.
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
BinaryRouteRepresentation
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.
Type: TByteDynArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerSimpleCalculateRouteWithBinaryResult__mcsResult class.
Encapsulates all output values for RoutePlannerSimpleCalculateRouteWithBinaryResult function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost without viaTOLL costs.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
BinaryRouteRepresentation
Geographic route representation - a list of all points forming a route returned in binary format (each point is encoded in 16 bytes, 8 bytes for latitude and 8 bytes for longitude as Intel compatible double real numbers). Returned if option ReturnRouteRepresentation is set to True.
Type: TByteDynArray
RouteItinerary
Resultant route itinerary - a list of all route events. Returned if option ReturnRouteItinerary is set to True.
RoutePlanEntriesDescription
A list of automatic generated geographical waypoint descriptons - information on waypoint nearest city, street or road. Returned if option ReturnRoutePlanEntriesDescription is set to True.
Type: TWideStringArray
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
UnreachableEntry
Index of unreachable waypoint (essential when route could not be calculated). The first waypoint has index 0, second has index 1 and so on.
Type: Integer
TSoapRoutePlannerVehicleParamExGet__mcsResult class.
Encapsulates all output values for RoutePlannerVehicleParamExGet function
Properties:PasamValue
Parameter value.
Type: WideString
TSoapRoutePlannerVehicleParamsExGet__mcsResult class.
Encapsulates all output values for RoutePlannerVehicleParamsExGet function
Properties:TSoapRoutePlannerVehicleParamsGet__mcsResult class.
Encapsulates all output values for RoutePlannerVehicleParamsGet function
Properties:TSoapRoutePlannerVehicleParamsGet2__mcsResult class.
Encapsulates all output values for RoutePlannerVehicleParamsGet2 function
Properties:TSoapRouteRepositoryCalculatePointDistanceFromRoute__mcsResult class.
Encapsulates all output values for RouteRepositoryCalculatePointDistanceFromRoute function
Properties:DistanceFromRoutes
Resultant matrix of calculated distances (in meters) - for each route and for each point. If calculated distance is greater then MaxLength, it will equal 0.
Type: TSoapTFloatArrayArray
TSoapRouteRepositoryGetRouteItinerary__mcsResult class.
Encapsulates all output values for RouteRepositoryGetRouteItinerary function
Properties:RouteItinerary
Resultant route itinerary - a list of all route events.
TSoapRouteRepositoryGetRouteItineraryByIdent__mcsResult class.
Encapsulates all output values for RouteRepositoryGetRouteItineraryByIdent function
Properties:RouteItinerary
Resultant route itinerary - a list of all route events.
TSoapRouteRepositoryGetRouteRepresentation__mcsResult class.
Encapsulates all output values for RouteRepositoryGetRouteRepresentation function
Properties:RouteRepresentation
Geographic route representation - a list of all points forming a route.
Type: TSoapTLongLatPointArray
TSoapRouteRepositoryGetRouteRepresentationByIdent__mcsResult class.
Encapsulates all output values for RouteRepositoryGetRouteRepresentationByIdent function
Properties:RouteRepresentation
Geographic route representation - a list of all points forming a route.
Type: TSoapTLongLatPointArray
TSoapRouteRepositoryGetRoutes__mcsResult class.
Encapsulates all output values for RouteRepositoryGetRoutes function
Properties:TSoapRouteRepositoryGetRoutesCount__mcsResult class.
Encapsulates all output values for RouteRepositoryGetRoutesCount function
Properties:Count
Repository routes count.
Type: Integer
TSoapRouteRepositoryGetRouteSummary__mcsResult class.
Encapsulates all output values for RouteRepositoryGetRouteSummary function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
TSoapRouteRepositoryGetRouteSummaryByIdent__mcsResult class.
Encapsulates all output values for RouteRepositoryGetRouteSummaryByIdent function
Properties:TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
RouteCalculateType
Route type:
- shortest = 0x00
- quickest = 0x01
- cheapest = 0x02
Type: Integer
TSoapRouteRepositoryStoreToBlob__mcsResult class.
Encapsulates all output values for RouteRepositoryStoreToBlob function
Properties:BinaryRepresentation
Returned binary representation of route repository.
Type: TByteDynArray
TSoapSearchAddCityToSelection__mcsResult class.
Encapsulates all output values for SearchAddCityToSelection function
Properties:BoundingRect
Geographic coordinates of the rectangle bounding the city area.
Type: TSoapTLongLatRect
TSoapSearchAddObjectToSelection__mcsResult class.
Encapsulates all output values for SearchAddObjectToSelection function
Properties:BoundingRect
Geographic coordinates of the rectangle bounding the area of the map element.
Type: TSoapTLongLatRect
TSoapSearchAddStreetCrossingToSelection__mcsResult class.
Encapsulates all output values for SearchAddStreetCrossingToSelection function
Properties:TSoapSearchAddStreetWithNumToSelection__mcsResult class.
Encapsulates all output values for SearchAddStreetWithNumToSelection function
Properties:TSoapSearchGetCityList__mcsResult class.
Encapsulates all output values for SearchGetCityList function
Properties:CityAdmAbbrev
The list of abbreviations for administrative regions containing found cities. Country and lower level area abreviations are returned for each city as a list of strings.
CityAdmNames
The list of administrative regions containing found cities. Country and lower level area names are returned for each city as a list of strings.
TSoapSearchGetCityListEx__mcsResult class.
Encapsulates all output values for SearchGetCityListEx function
Properties:CityAdmAbbrev
The list of abbreviations for administrative regions containing found cities. Country and lower level area abreviations are returned for each city in form of one string containing the abbreviations separated with character '|'.
Type: TWideStringArray
CityAdmNames
The list of administrative regions containing found cities. Country and lower level area names are returned for each city in form of one string containing the names separated with character '|'.
Type: TWideStringArray
TSoapSearchGetCountryList__mcsResult class.
Encapsulates all output values for SearchGetCountryList function
Properties:TSoapSearchGetItemKindList__mcsResult class.
Encapsulates all output values for SearchGetItemKindList function
Properties:ItemKindNames
The list of element kinds. Currenty the list contains: squares, estates, quarters, highway exits, airports, roads, rivers, lakes, cemeteries, parks.
Type: TWideStringArray
TSoapSearchGetItemsList__mcsResult class.
Encapsulates all output values for SearchGetItemsList function
Properties:ItemTypes
The list of corresponding element kinds being indices in the list returned by SearchGetItemKindList function.
Type: TDynamicIntegerArray
TSoapSearchGetParamValue__mcsResult class.
Encapsulates all output values for SearchGetParamValue function
Properties:ParamValue
Parameter value.
Type: WideString
TSoapSearchGetParamValues__mcsResult class.
Encapsulates all output values for SearchGetParamValues function
Properties:TSoapSearchGetStreetHandle__mcsResult class.
Encapsulates all output values for SearchGetStreetHandle function
Properties:StreetHandle
A handle to the element.
Type: Integer
TSoapSearchSelectCities__mcsResult class.
Encapsulates all output values for SearchSelectCities function
Properties:ResultCount
The count of found cities.
Type: Integer
TSoapSearchSelectItems__mcsResult class.
Encapsulates all output values for SearchSelectItems function
Properties:ResultCount
The count of found elements.
Type: Integer
TSoapSearchSelectItemsEx__mcsResult class.
Encapsulates all output values for SearchSelectItemsEx function
Properties:ResultCount
The count of found elements.
Type: Integer
TSoapServiceConfigGetServiceParams__mcsResult class.
Encapsulates all output values for ServiceConfigGetServiceParams function
Properties:TSoapTDegeocodeAtPointDatabaseResult class.
An information concerning a non map object being a result of degeocoding.
Properties:Category
The category of the object found:
- Objects - MapBase
objects
- Logistics - logistic objects from MapBase, i.e. traffic
difficulties
- Localize - licalization objects
- CalculatedRoute -
points of route representation
- RoutePlannerEntries - route waypoints
-
TrafficInformation - traffic difficulties stored in the session or subscribed
from difficulty providers
Type: WideString
Name
Object name or multiline description.
Type: WideString
ID
Object identifier.
Type: Integer
FoundLength
Distance (in meters) between found object and the degeocoded point.
Type: Double
TSoapTDegeocodeAtPointResult class.
An information concerning a map element being a result of degeocoding.
Properties:Category
The category of the element: Forest, Park, Cemetery, River, Lake, Railstation, Building, Square, Estate, Quarter, Highway exit, Airport, Peak, Border crossing and others.
Type: WideString
Name
Map element name.
Type: WideString
FoundLength
Distance (in meters) between found map element and the degeocoded point.
Type: Double
TSoapTDegeocodeCityElementResult class.
An information concerning a city being a result of degeocoding.
Properties:Name
City name.
Type: WideString
FoundLength
Distance (in meters) between found city and the degeocoded point.
Type: Double
TSoapTDegeocodeExResultEntry class.
An information concerning an element being a result of extended degeocoding.
Properties:PointIndex
An index within the array of degeocoded points which the entry is for, beginning with 0 for the first point.
Type: Integer
LayerName
Layer name.
Type: WideString
Name
Map element name.
Type: WideString
FoundLength
Distance (in meters) between found map element and the degeocoded point.
Type: Double
TSoapTDegeocodeResult class.
Geographic information concerning a point on map.
Properties:AreaName0
Country name.
Type: WideString
AreaName1
The name of 2nd level administrative area, i.e. a county.
Type: WideString
AreaName2
The name of 3rd level administrative area, i.e. a district.
Type: WideString
AreaName3
The name of 4th level administrative area.
Type: WideString
Zip
Postal code.
Type: WideString
TSoapTDegeocodeResultEntry class.
An information concerning a map element being a result of degeocoding.
Properties:Name
Map element name.
Type: WideString
FoundLength
Distance (in meters) between found map element and the degeocoded point.
Type: Double
TSoapTDegeocodeRoadElementResult class.
An information concerning a road being a result of degeocoding.
Properties:Name
Road name.
Type: WideString
IsDirectional
This value is set to true if the road is one-direction road. Otherwise it is set to false.
Type: Boolean
IsPassable
This value is set to true if the road is passable. Otherwise it is set to false.
Type: Boolean
TypeIndex
The type a the road. The meaning of the value is:
-
highway = 0
- speedway = 1
- national road = 2
- regional road =
3
- local road = 4
- main street = 5
- street = 6
- ferry path =
7
Type: Integer
FoundLength
Distance (in meters) between found road and the degeocoded point.
Type: Double
TSoapTDriverParams class.
Driver parameters.
Properties:JourneyStartTime
Work start time, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Type: Double
DayWorkTime
Day work time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
ContinuousWorkTime
Continuous work time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
BreakTime
Break time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
CostPerKilometer
Cost of 1 kilometer long route sector passed by the driver. It must be nonnegative float value.
Type: Double
CostPerHour
Cost of 1 hour route duration passed by the driver. It must be nonnegative float value.
Type: Double
TSoapTDriveThrough class.
Waypoint properties.
Properties:EntryIndex
Index of a position in the waypoint list. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function.
Type: Integer
SetAsDriveThrough
Option of setting the waypoint as a drive through waypoint.
Type: Boolean
Radius
Waypoint radius in meters (driving tollerance). It must be nonnegative value.
Type: Double
TSoapTFontParameters class.
A font parameters.
Properties:Name
Font name.
Type: WideString
Size
A size of the font.
Type: Integer
Style
Font style. It is a bit vector - each bit deals with one
font style feature:
- bold = 0x01
- italic = 0x02
- underline =
0x04
- strikeout = 0x08
Type: Integer
Charset
Font charset. It is one of following values:
- ANSI
charset = 0x00
- default fon charset = 0x01
- eastern european charset =
0xEE
- OEM (operating system depended) charset = 0xFF
Type: Integer
TSoapTGeocodePointInfo class.
Address information.
Properties:Country
Country name.
Type: WideString
County
The name of 2nd level administrative area, i.e. a county.
Type: WideString
District
The name of 3rd level administrative area, i.e. a district.
Type: WideString
City
City name.
Type: WideString
Zip
Postal code.
Type: WideString
Street
Street name.
Type: WideString
StreetNumber
Number of building on the street.
Type: WideString
TSoapTGeocodePointInfoEx class.
Extended address information. City, street and administrative abbreviations (terminated with dot) are permitted.
Properties:Country
Country name.
Type: WideString
County
The name of 2nd level administrative area, i.e. a county.
Type: WideString
District
The name of 3rd level administrative area, i.e. a district.
Type: WideString
Commune
The name of 4rd level administrative area, i.e. a commune.
Type: WideString
City
City name.
Type: WideString
Zip
Postal code.
Type: WideString
Street
Street name.
Type: WideString
StreetNumber
Number of building on the street.
Type: WideString
TSoapTGroupSettings class.
Visual settings of an object group.
Properties:GroupName
Name of object group.
Type: WideString
IconVisible
Indicates whether the object icons are drawn on maps.
Type: Boolean
IconID
Index of icon assigned to the object group. Value 0 means the group has no icon assigned - its icon is dynamically drawn. Otherwise, the index must be one of icon indices returned by GetGroupIcons function.
Type: Integer
IconSize
Radius (in pixels) of dynamically drawn object icon. It must be a positive value. The value is essential only when IconIndex equals 0.
Type: Integer
IconFillSign
If this option is set to False , dynamically drawn object icon is transparent, otherwise no. The value is essential only when IconIndex equals 0.
Type: Boolean
IconColor
The color of the icon. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red). The value is essential only when IconIndex equals 0.
Type: TColor
IconBorderSize
Width (in pixels) of the icon border. It must be a nonnegative value. The value is essential only when IconIndex equals 0.
Type: Integer
IconBorderColor
The color of the icon border. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red). The value is essential only when IconIndex equals 0.
Type: TColor
IconZoomMin
Minimum zoom of object icon visibility being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
IconZoomMax
Maximum zoom of object icon visibility being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
NameVisible
Indicates whether the object names are drawn on maps.
Type: Boolean
NameZoomMin
Minimum zoom of object name visibility being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
NameZoomMax
Maximum zoom of object name visibility being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
TSoapTGroupShapeSettings class.
Visual shape settings of an object group.
Properties:ShapeVisible
Indicates whether the object shapes are drawn on maps.
Type: Boolean
ShapeUnderMap
Indicates whether the object shapes are drawn under maps as a background.
Type: Boolean
ShapeFill
Indicates whether to fill the interior the object shapes.
Type: Boolean
ShapeColor
The color of shape interiors. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: TColor
ShapeBorderSize
Width (in pixels) of the shape border. It must be a nonnegative value.
Type: Integer
ShapeBorderColor
The color of shape borders. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: TColor
ShapeZoomMin
Minimum zoom of object shape visibility being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
ShapeZoomMax
Maximum zoom of object shape visibility being an altitude expressed in meters over sea level. It must be positive value.
Type: Double
TSoapTIconProperties class.
Icon properties.
Properties:IconID
A unique icon identifier.
Type: Integer
IconFormat
Format of the icon. Supported formats can be received using GetAvailableIconFormats function.
Type: WideString
IsTransparent
Option of icon transparency.
Type: Boolean
TransparentColor
The color of the icon transparency. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
TSoapTImageRenderParams class.
Parameters used while map image creation.
Properties:RenderWithoutSessionObjects
Option of putting on a map additional session elements, such as search selections, database objects, etc.
Type: Boolean
DPI
Resulution of the map image expressed in dots per inch. It must be positive value.
Type: Integer
Antialiasing
Option of antialiasing (smoothing) elements of the map image.
Type: Boolean
RenderParams
Other parameters (for future use).
Type: WideString
TSoapTLocalizeObjectPositionData class.
Properties of a localized object position.
Properties:Time
Time (in the GMT time zone) of the position (number of days since 30-12-1899 12:00 AM).
Type: Double
Description
The position description, displayed next to the position of an object on the map when the ShowDescription option is active. If the ShowIcon option is active, the description is displayed under the icon.
Type: WideString
ShowDescription
Information on whether to display the description of the position of the object on the map.
Type: Boolean
ShowName
Information on whether to display the name of the object next to the position of the object on the map, unless the ShowName option is deactivated directly for the localized object (concerns only the last object position).
Type: Boolean
IconID
A unique identifier of icon saved in the icons collection in the server session.
Type: Integer
ShowIcon
Information on whether to display the icon in the given position of the object on the map, unless the ShowIcon option is deactivated directly for the localized object (concerns only the last object position).
Type: Boolean
IconColor
The color of the icon, which replaces in it the so-called modifiable color, set permanently at the value 0x00FF00FF. It must be a value in 0x00BBGGRR format (BB=blue, GG=green, RR=red).
Type: Integer
TSoapTLogisticTOLLResults class.
Summaric cost results of toll roads for the given country.
Properties:CountryName
Name of the country.
Type: WideString
EntryType
Toll type, e.g. Charge, Vignette.
Type: WideString
PaymentCurrency
Official abbreviation for the original currency.
Type: WideString
PaymentOriginalCurrency
Cost in the original currency.
Type: Double
PaymentLocalCurrency
Cost in the local currency set in the sever session.
Type: Double
VAT
Tax rate (in percents).
Type: Double
TSoapTLongLatPoint class.
A geographic point based on the WGS84 coordinate system (datum).
Properties:Longitude
Longitude coordinate of the point. It is float value between -180 and 180. Negative values concern western hemisphere (W), positive - eastern (E).
Type: Double
Latitude
Latitude coordinate of the point. It is float value between -90 and 90. Negative values concern southern hemisphere (S), positive - northern (N).
Type: Double
TSoapTMapFileEntry class.
Properties of map file loaded by server.
Properties:Filename
Name of the file.
Type: WideString
Activated
Map file activity
Type: Boolean
TSoapTMultiGeocodePointInfoEx class.
Extended address information. City, street and administrative abbreviations (terminated with dot) are permitted.
Properties:SourceIndex
An index within the array of geocoded addresses which the entry is for, beginning with 0 for the first address.
Type: Integer
Country
Country name.
Type: WideString
County
The name of 2nd level administrative area, i.e. a county.
Type: WideString
District
The name of 3rd level administrative area, i.e. a district.
Type: WideString
Commune
The name of 4rd level administrative area, i.e. a commune.
Type: WideString
City
City name.
Type: WideString
Zip
Postal code.
Type: WideString
Street
Street name.
Type: WideString
StreetNumber
Number of building on the street.
Type: WideString
GeocodeLevel
A list of resultant geocode levels for proposals found. The
geocode level is a bit vector - each bit deals with one address item:
-
country = 0x01
- 2nd level administrative area (county) = 0x02
- 3rd
level administrative area (district) = 0x04
- city = 0x08
- postal code
= 0x10
- street = 0x20
- building numeration = 0x40
- 4rd level
administrative area (commune) = 0x80
If an address item was taken into
account while geocoding process, its bit is set to 1. If an address was not
geocoded, the geocode level for it has value 0 (all bits set to 0).
Type: Byte
BoundingRect
Geographic coordinates of the rectangles bounding objects found.
Type: TSoapTLongLatRect
TSoapTObjectPosition class.
Geographic data of an object.
Properties:Status
Status of object geographic position obtained while
geocoding process (geocode level). The geocode level is a bit vector - each bit
deals with one address item:
- country = 0x01
- 2nd level administrative
area (county) = 0x02
- 3rd level administrative area (district) = 0x04
-
city = 0x08
- postal code = 0x10
- street = 0x20
- building
numeration = 0x40
- manually geocoded = 0x80
If an address item was
taken into account while geocoding process, its bit is set to 1. If an address
was not geocoded, the geocode level for it has value 0 (all bits set to 0).
Type: TGeocodeStatus
TSoapTPoint class.
Properties:X
Type: Integer
Y
Type: Integer
TSoapTRect class.
Properties:TopLeft
Type: TSoapTPoint
BottomRight
Type: TSoapTPoint
TSoapTRepositoryRoute class.
Properties of route stored in the route repository.
Properties:Ident
Identifier.
Type: Integer
Description
Description.
Type: WideString
Visible
Indicates whether to display a route on maps or not.
Type: Boolean
TotalRouteLength
Total route length in meters.
Type: Double
TotalRouteTime
Total route duration time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TotalRouteCost
Total route cost.
Type: Double
TotalFuelCost
Total fuel cost.
Type: Double
TollRoadLength
Total length of toll route sectors.
Type: Double
TollRoadTime
Total duration time of toll route sectors, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
AdditionalRouteCost
Additional costs of a route, i.e. cost of route impediments.
Type: Double
BoundingRect
Geographic coordinates of the rectangle bounding the route area.
Type: TSoapTLongLatRect
TSoapTRoadParams class.
Road parameters.
Properties:RoadType
Road type. Supported types can be received using GetAvailableRoadTypes function.
Type: WideString
Use
Option of using roads of the type while route calculating.
Type: Boolean
Speed
Maximum speed permitted on roads of the type (in km/h). It must be nonnegative value.
Type: Double
Combustion
Fuel combustion on road of the type (in l/100km). It must be nonnegative value.
Type: Double
TSoapTRoadResults class.
Summaric route results taking into account roads of one given type.
Properties:RoadType
Road type. Supported types can be received using GetAvailableRoadTypes function.
Type: WideString
Length
Route length in meters.
Type: Double
Time
Route duration, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
FuelCost
Fuel combustion cost.
Type: Double
VehicleKilometerCost
Vehicle kilometer cost.
Type: Double
VehicleHourCost
Vehicle time cost.
Type: Double
DriverKilometerCost
Driver kilometer cost.
Type: Double
DriverHourCost
Driver time cost.
Type: Double
TSoapTRoadViaTollParams class.
viaTOLL parameters.
Properties:RoadType
Road type. Supported types can be received using GetAvailableRoadTypes function.
Type: WideString
ViaTollCost
Cost per km.
Type: Double
TSoapTRouteAttributeParams class.
Properties of routing difficulty.
Properties:AttributeID
Difficulty unique identifier.
Type: Integer
VehicleFilter
A list of vehicle types the difficulty concerns. The vehicle
filter is a bit vector - each bit deals with one vehicle type:
- Passenger
car = 0x01
- Transport truck = 0x02
- Motorcycle = 0x04
- Pedestrian
= 0x08
- Bicycle = 0x10
- Delivery truck = 0x20
- Residental vehicle
= 0x40
- Taxi = 0x80
- Public bus = 0x100
- Straight truck =
0x200
- Non-standard vehicle = 0x400
Type: Integer
AttributeName
Difficulty name.
Type: WideString
AttributeDescription
Difficulty description.
Type: WideString
Closed
Option of blocking routing through the difficulty.
Type: Boolean
TwoDirectionalTraffic
Option of enabling two directional traffic through the difficulty.
Type: Boolean
MaxSpeed
Maximum speed allowed while routing through the difficulty (in km/h).
Type: Integer
MaxWeight
Maximum vehicle weight allowed while routing through the difficulty (in tons).
Type: Double
MaxWidth
Maximum vehicle widht allowed while routing through the difficulty (in meters).
Type: Double
MaxHeight
Maximum vehicle height allowed while routing through the difficulty (in meters).
Type: Double
AdditonalCost
Cost of passing through the difficulty.
Type: Double
AdditionalTime
Time of passing through the difficulty, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
BeginTime
Time (in the GMT time zone) of the difficulty binding start (number of days since 30-12-1899 12:00 AM).
Type: Double
EndTime
Time (in the GMT time zone) of the difficulty binding stop (number of days since 30-12-1899 12:00 AM).
Type: Double
BeginDayTime
Time within a day of difficulty binding start, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Type: Double
EndDayTime
Time within a day of difficulty binding stop, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Type: Double
TSoapTRouteAttributePassedElem class.
Properties of the routing difficulty collected while route calculation analyzing.
Properties:SubscriberName
Name of the difficulty provider.
Type: WideString
AttributeID
Difficulty unique identifier.
Type: Integer
BlockReasonBits
A list of route blocking reasons - a bit vector, each bit
deals with one reason:
- impassable way = 0x01
- weight overflow =
0x02
- width overflow = 0x04
- height overflow = 0x08
- length
overflow = 0x10
- weight per axle overflow = 0x20
- load type blocked =
0x40
Type: Integer
TSoapTRouteItinerary class.
Route itinerary entry parameters.
Properties:ItineraryType
Event type:
- Other action = 0x00
- Depart from a
waypoint = 0x1
- Arrive at a waypoint = 0x02
- Turn left = 0x03
-
Turn right = 0x04
- Bear left = 0x05
- Bear right = 0x6
- Merge onto
a highway or motorway, or limited-access road = 0x07
- Continue traveling in
the same direction as in the previous instruction = 0x08
- Turn back to
travel in the opposite direction as the previous direction = 0x09
- Take a
roundabout = 0x0A
- A warning indicating that delays can be expected because
of construction = 0x0B
- A warning indicating that stops or road closures
can be expected because of road construction = 0x0C
- A warning indicating
that the name of the road changes = 0x0D
- Turn or bear left, and then
immediately turn or bear left = 0x0E
- Turn or bear left, and then
immediately turn or bear right = 0x0F
- Turn or bear right, and then
immediately turn or bear left = 0x10
- Turn or bear right, and then
immediately turn or bear right = 0x11
- Take a ramp = 0x12
- Take a ramp
to the left = 0x13
- Take a ramp to the right = 0x14
- Continue straight
when faced with multiple options = 0x15
- Stay to the left when faced with
multiple options = 0x16
- Stay to the right when faced with multiple options
= 0x17
- Border crossing = 0x18
- Beginning of journey day = 0x19
-
End of journey day = 0x1A
- Toll-road gate = 0x1B
- Beginning of
toll-road = 0x1C
- End of toll-road = 0x1D
- Beginning of driver rest
time = 0x1E
- End of driver rest time = 0x1F
- Beginning of ferry travel
= 0x20
- End of ferry travel = 0x21
- Refuel needed = 0x22
-
Beginning of charged road = 0x23
- End of charged road = 0x24
-
Beginning of viaTOLL road = 0x25
- End of viaTOLL road = 0x26
Type: Integer
ItineraryName0
Main description of event. In case of events concerning road name changes (0x03, 0x04, 0x05, 0x06, 0x07, 0x0A, 0x0D, 0x0E, 0x0F, 0x10, 0x11) it contains current road name. For waypoint events (0x01, 0x02) it is waypoint number (the first waypoint has number 1, second has number 2 and so on) and for day change events (0x19, 0x1A) - number of journey day.
Type: WideString
ItineraryName1
Additional description of event. In case of events concerning road name changes (0x03, 0x04, 0x05, 0x06, 0x07, 0x0A, 0x0D, 0x0E, 0x0F, 0x10, 0x11) it contains next (target) road name. For waypoint events (0x01, 0x02) it is waypoint description.
Type: WideString
EntryDistance
Current route distance from a route start point.
Type: Double
EntryTime
Current route time, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Type: Double
EntryCost
Current route cost.
Type: Double
TSoapTRouteOptimalizationEntry class.
Properties of the waypoint entry for route optimization purposes.
Properties:SourceEntryIndex
Original waypoint index before optimization process. The first waypoint has index 0, second has index 1 and so on.
Type: Integer
DestinationEntryIndex
Result waypoint index after optimization process. The first waypoint has index 0, second has index 1 and so on.
Type: Integer
DroppedEntry
For future use.
Type: Boolean
DayAssigment
For future use.
Type: Integer
DriverAssigment
For future use.
Type: Integer
TSoapTRouteOptimizerEntry class.
Properties of the optimized route segment.
Properties:ResultRouteInfoIndex
Index of the route within the list of optimized routes, beginning with 0 for the first route.
Type: Integer
FromEntryIndex
Start waypoint index for the segment.
Type: Integer
ToEntryIndex
Stop waypoint index for the segment.
Type: Integer
Duration
Time duration of the segment (in minutes).
Type: Integer
Arrival
Arrival time shift for the stop waypoint of the segment (in minutes).
Type: Integer
Wait
Time to wait after arrival to the stop waypoint of the segment (in minutes).
Type: Integer
ShortBreak
Break time occured within the segment, which is necessary after contigous driving without a break (in minutes).
Type: Integer
TSoapTRouteOptimizerEntry2 class.
Properties of the optimized route segment.
Properties:ResultRouteInfoIndex
Index of the route within the list of optimized routes, beginning with 0 for the first route.
Type: Integer
EntryIndex
Type: Integer
Duration
Time duration of the segment (in minutes).
Type: Integer
Arrival
Arrival time shift for the stop waypoint of the segment (in minutes).
Type: Integer
Wait
Time to wait after arrival to the stop waypoint of the segment (in minutes).
Type: Integer
ShortBreak
Break time occured within the segment, which is necessary after contigous driving without a break (in minutes).
Type: Integer
TSoapTRouteOptimizerEntryAction2 class.
Properties of a single shipment action.
Properties:EntryIndex
Type: Integer
TimingBegin
Time shift of the beginning of the action (in minutes).
Type: Integer
TimingEnd
Time shift of the end of the action (in minutes).
Type: Integer
ShipmentId
Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by EntryIndex.
Type: WideString
Pickup
Type: Boolean
TSoapTRouteOptimizerResultRoutesEntry class.
Properties of the optimized route.
Properties:TimingBegin
Time shift of route beginning (in minutes).
Type: Integer
TimingEnd
Time shift of route end (in minutes).
Type: Integer
Cost
Total route cost in hundreth parts of the main currency.
Type: Integer
VehicleCategory
Category of vehicle for the route.
Type: WideString
TSoapTRouteOptimizerShipmentAction class.
Properties of a single shipment action.
Properties:EntryIndex
Index of the optimizer entry (route segment) to perform the action, being an index of one of the item in resultant array of type TRouteOptimizerEntryArray, beginning with 0 for the first entry.
Type: Integer
IsFromEntry
Indicates whether the action concerns start waypoint of the route segment (FromEntryIndex, when value is true) or stop waypoint (ToEntryIndex, when value is false).
Type: Boolean
TimingBegin
Time shift of the beginning of the action (in minutes).
Type: Integer
TimingEnd
Time shift of the end of the action (in minutes).
Type: Integer
ShipmentId
Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by EntryIndex.
Type: WideString
TSoapTRouteOptimizerShipmentMove class.
Properties of the optimizer shipment event.
Properties:ResultRouteInfoIndex
Index of the route within the list of optimized routes, beginning with 0 for the first route.
Type: Integer
ShipmentId
Shipment identifier. It is identifier of one of the shipments defined for the waypoint referenced by PickupEntryIndex or DeliverEntryIndex.
Type: WideString
PickupEntryIndex
Waypoint index of pickup shipment, beginning with 0 for the first waypoint.
Type: Integer
DeliveryEntryIndex
Waypoint index of delivery shipment, beginning with 0 for the first waypoint.
Type: Integer
LoadCapacitySize
Size of the shipment (in dm3).
Type: Integer
LoadCapacityWeight
Weight of the shipment (in kilograms).
Type: Integer
TSoapTSessionEnumEntry class.
Properties of a server session.
Properties:SessionID
Session identifier.
Type: WideString
SessionIP
IP address of client application, which is owner of the session.
Type: WideString
SessionCreateTime
Time of session creation. Time (in the GMT time zone) is number of days since 30-12-1899 12:00 AM.
Type: Double
SessionAccessTime
Time of last session query. Time (in the GMT time zone) is number of days since 30-12-1899 12:00 AM.
Type: Double
SessionAccessTimes
Number of queries requested by session.
Type: Integer
SessionUserName
Name of user assigned to session.
Type: WideString
SessionComment
Session comment.
Type: WideString
TSoapTShipment class.
Properties of the shipment definition.
Properties:ShipmentID
Shipment identifier.
Type: WideString
ShipmentType
Shipment type. The list of currently defined shipment types may be obtained using RouteOptimizerShipmentTypesGet function.
Type: WideString
ShipmentSize
Shipment size in m3.
Type: Double
ShipmentWeight
Shipment weight (in tons).
Type: Double
ShipmentLoadTime
Time of shipment loading (in minutes).
Type: Integer
ShipmentUnloadTime
Time of shipment unloading (in minutes).
Type: Integer
TSoapTShipmentTypeToShipmentTypeIncompatibility class.
A pair of shipment types.
Properties:ShipmentType1
First shipment type.
Type: WideString
ShipmentType2
Second shipment type.
Type: WideString
TSoapTTiledMapParams class.
Parameters used while tiled map image creation.
Properties:Antialiasing
Option of antialiasing (smoothing) elements of the map image.
Type: Boolean
TSoapTTimeWindow class.
Properties of the time window definiton.
Properties:TimeFrom
Beginning time of the time window, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Type: Double
TimeTo
Ending time of the time window, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Type: Double
TSoapTVehicleCategoryToShipmentTypeIncompatibility class.
A pair of vehilce category and shipment type.
Properties:VehicleCategory
Vehicle category.
Type: WideString
ShipmentType
Shipment type.
Type: WideString
TSoapTVehicleEntry class.
Vehicle parameters - TVehicleParams extended with name, external type, count of vehicles and weight per axle.
Properties:VehicleCategory
Vehicle category.
Type: WideString
VehicleName
Vehicle name. For future use.
Type: WideString
VehicleType
Vehicle type:
- Passenger car = 0x00
- Transport
truck = 0x01
- Motorcycle = 0x02
- Pedestrian = 0x03
- Bicycle =
0x04
- Delivery truck = 0x05
- Residental vehicle = 0x06
- Taxi =
0x07
- Public bus = 0x08
- Straight truck = 0x09
- Non-standard
vehicle = 0x0A
Type: Integer
IgnoreFuel
Option of taking fuel combustion into account while route calculating.
Type: Boolean
FixedCost
Fixed route cost. It must be nonnegative float value.
Type: Double
CostPerKilometer
Cost of 1 kilometer long route sector passed by the vehicle. It must be nonnegative float value.
Type: Double
CostPerHour
Cost of 1 hour route duration passed by the vehicle. It must be nonnegative float value.
Type: Double
TollRoadPerKilometer
Cost of 1 kilometer long toll-road.
Type: Double
TankCapacity
Vehicle tank capacity in litres. It must be nonnegative float value.
Type: Double
FuelCost
Cost of one fuel unit. It must be nonnegative float value.
Type: Double
RefuelTime
Refuel time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
VehicleWeight
Vehicle weight in tons. Ignored if 0.
Type: Double
VehicleWeightPerAxle
Weight per axle in tons. Ignored if 0.
Type: Double
VehicleLength
Vehicle length in meters. Ignored if 0.
Type: Double
VehicleHeight
Vehicle height in meters. Ignored if 0.
Type: Double
VehicleWidth
Vehicle width in meters. Ignored if 0.
Type: Double
VehicleCapacity
Vehicle capacity in m3. It must be nonnegative float value.
Type: Double
VehicleLoadCapacity
Vehicle load capacity in tons. It must be nonnegative float value.
Type: Double
VehicleMaxCount
Maximal number of vehicles of this kind available.
Type: Integer
VehicleLoadType
Vehicle load type. It is a bit vector - each bit deals with
one type:
- General hazardous materials = 0x01
- Explosive materials =
0x02
- Goods harmful to water = 0x04
Type: Integer
ShippingTime
Ferry shipping time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
BorderPassTime
Border pass time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
VehicleLoadTime
Time of vehicle loading (in minutes).
Type: Integer
VehicleUnloadTime
Time of vehicle unloading (in minutes).
Type: Integer
VehicleAvailableFrom
Beginning time of the vehicle availability, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Type: Double
VehicleAvailableTo
Ending time of the vehicle availability, when value 1/24 means 01:00 a.m, 2/24 means 02:00 a.m. and so on.
Type: Double
VehicleMaxRouteDuration
Maximal duration of a single route (in minutes).
Type: Integer
VehicleMaxCumulDrivingBeforeShortBreak
Maximal duration of a contigous driving without a break (in minutes).
Type: Integer
VehicleMaxWaitingTime
Maximal time of waiting at a single route point (in minutes).
Type: Integer
VehicleCanDoManyLoads
Option of multiple loadability. For future use.
Type: Boolean
VehicleStartingLocationIndex
Index of the starting waypoint for the vehicle. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function. For future use.
Type: Integer
VehicleFinishingLocationIndex
Index of the finishing waypoint for the vehicle. It must be a value between 0 and count-1, when count may be obtained using RoutePlannerEntriesGetCount function. For future use.
Type: Integer
TSoapTVehicleParams class.
Vehicle parameters.
Properties:VehicleType
Vehicle type:
- Passenger car = 0x00
- Transport
truck = 0x01
- Motorcycle = 0x02
- Pedestrian = 0x03
- Bicycle =
0x04
- Delivery truck = 0x05
- Residental vehicle = 0x06
- Taxi =
0x07
- Public bus = 0x08
- Straight truck = 0x09
- Non-standard
vehicle = 0x0A
Type: Integer
IgnoreFuel
Option of taking fuel combustion into account while route calculating.
Type: Boolean
FixedCost
Fixed route cost. It must be nonnegative float value.
Type: Double
CostPerKilometer
Cost of 1 kilometer long route sector passed by the vehicle. It must be nonnegative float value.
Type: Double
CostPerHour
Cost of 1 hour route duration passed by the vehicle. It must be nonnegative float value.
Type: Double
TollRoadPerKilometer
Cost of 1 kilometer long toll-road.
Type: Double
TankCapacity
Vehicle tank capacity in litres. It must be nonnegative float value.
Type: Double
FuelCost
Cost of one fuel unit. It must be nonnegative float value.
Type: Double
RefuelTime
Refuel time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
VehicleWeight
Vehicle weight in tons. Ignored if 0.
Type: Double
VehicleLength
Vehicle length in meters. Ignored if 0.
Type: Double
VehicleHeight
Vehicle height in meters. Ignored if 0.
Type: Double
VehicleWidth
Vehicle width in meters. Ignored if 0.
Type: Double
VehicleCapacity
Vehicle capacity in m3. It must be nonnegative float value.
Type: Double
VehicleLoadCapacity
Vehicle load capacity in tons. It must be nonnegative float value.
Type: Double
ShippingTime
Ferry shipping time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
BorderPassTime
Border pass time, when value 1 means 1 day, 0.5 means 12 hours and so on.
Type: Double
TSoapTViaTollRoadResults class.
Summaric viaTOLL results taking into account roads of one given type.
Properties:RoadType
Road type. Supported types can be received using GetAvailableRoadTypes function.
Type: WideString
ViaTollLength
Route length in meters.
Type: Double
ViaTollCost
viaTOLL cost.
Type: Double
TSoapTViewConfigEntry class.
Properties of view config file loaded by server.
Properties:ConfigName
View config name.
Type: WideString
Filename
Name of the file.
Type: WideString
TSoapVehicleRepositoryDriverParamsGet__mcsResult class.
Encapsulates all output values for VehicleRepositoryDriverParamsGet function
Properties:TSoapVehicleRepositoryRoadParamsGet__mcsResult class.
Encapsulates all output values for VehicleRepositoryRoadParamsGet function
Properties:TSoapVehicleRepositoryVehicleGet__mcsResult class.
Encapsulates all output values for VehicleRepositoryVehicleGet function
Properties:TSoapVehicleRepositoryVehiclesGet__mcsResult class.
Encapsulates all output values for VehicleRepositoryVehiclesGet function
Properties:TSoapVehicleRepositoryVehicleViaTollGet__mcsResult class.
Encapsulates all output values for VehicleRepositoryVehicleViaTollGet function
Properties:FunctionUnimplemented
Category: Standard errors
Code: -2
SessionNotFound
Category: Standard errors
Code: -3
NonauthorizedAccess
Category: Standard errors
Code: -4
NotEnoughPermission
Category: Standard errors
Code: -5
SessionLimitExceeded
Category: Standard errors
Code: -10
UserSessionLimitExceeded
Category: Standard errors
Code: -11
ReferentialIntegrityError
Category: Data errors
Code: -6
UpdateRequired
Category: Data errors
Code: -9
DatabaseBlocked
Category: Data errors
Code: -12
GeneralSearchError
Category: Search errors
Code: -100
InvalidCountryIndex
Category: Search errors
Code: -101
InvalidCityIndex
Category: Search errors
Code: -102
InvalidCityCount
Category: Search errors
Code: -103
InvalidItemKindIndex
Category: Search errors
Code: -104
InvalidItemCount
Category: Search errors
Code: -105
InvalidItemIndex
Category: Search errors
Code: -106
StreetRequired
Category: Search errors
Code: -107
SearchContextNotInitialized
Category: Search errors
Code: -108
InvalidItemHandle
Category: Search errors
Code: -109
NumerationNotFound
Category: Search errors
Code: -110
GeneralLocalizeError
Category: Localize errors
Code: -200
InvalidLocalizeDataIndex
Category: Localize errors
Code: -201
InvalidLocalizeEntityID
Category: Localize errors
Code: -203
InvalidNumericFieldsCount
Category: Localize errors
Code: -204
InvalidStringFieldsCount
Category: Localize errors
Code: -205
DuplicatedLocalizeEntityID
Category: Localize errors
Code: -206
InvalidIconMIMEType
Category: Localize errors
Code: -207
InvalidItemsCount
Category: Localize errors
Code: -208
InvalidIconData
Category: Localize errors
Code: -209
GeneralMapFileError
Category: Map file errors
Code: -300
MapFileAlreadyOpened
Category: Map file errors
Code: -302
MapFileAlreadyClosed
Category: Map file errors
Code: -303
GeneralRenderingError
Category: Rendering errors
Code: -400
InvalidImageMIMEType
Category: Rendering errors
Code: -403
GeneralAuthorizationError
Category: Authorization errors
Code: -500
UserGroupAlreadyExists
Category: Authorization errors
Code: -503
UserGroupReadOnly
Category: Authorization errors
Code: -505
GeneralRoutePlannerError
Category: RoutePlanner errors
Code: -600
InvalidEntryIndex
Category: RoutePlanner errors
Code: -603
RouteNotFound
Category: RoutePlanner errors
Code: -605
DuplicatedEntryIndex
Category: RoutePlanner errors
Code: -606
RouteNotCalculated
Category: RoutePlanner errors
Code: -607
RouteIdentifierNotFound
Category: RoutePlanner errors
Code: -608
DuplicatedRoutingDifficultyIdentifier
Category: RoutePlanner errors
Code: -630
RoutingDifficultyIdentifierNotFound
Category: RoutePlanner errors
Code: -631
VehicleCategoryAlreadyExists
Category: RouteOptimizer errors
Code: -660
DepotEntryNotSet
Category: RouteOptimizer errors
Code: -661
DuplicatedShipmentIdentifier
Category: RouteOptimizer errors
Code: -662