MapController.GetMap Method |
Generate map SVG based on the current viewport, data, and requested map files.
Namespace:
Dundas.BI.WebApi.Controllers
Assembly:
Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.2.0.1000)
Syntax[HttpPostAttribute("GetMap")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<MapDataInfoSvgData> GetMap(
[FromBodyAttribute] GetMapsOptions options,
Guid? sessionId = null
)
<HttpPostAttribute("GetMap")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(410)>
<ProducesResponseTypeAttribute(440)>
Public Function GetMap (
<FromBodyAttribute> options As GetMapsOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of MapDataInfoSvgData)
public:
[HttpPostAttribute(L"GetMap")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(410)]
[ProducesResponseTypeAttribute(440)]
ActionResult<MapDataInfoSvgData^>^ GetMap(
[FromBodyAttribute] GetMapsOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("GetMap")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(410)>]
[<ProducesResponseTypeAttribute(440)>]
member GetMap :
[<FromBodyAttribute>] options : GetMapsOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<MapDataInfoSvgData>
Parameters
- options
- Type: Dundas.BI.WebApi.Models.GetMapsOptions
An object that carries all needed information about the maps that needs to be retrieved. - sessionId (Optional)
- Type: System.Nullable<Guid>
ID of the session.
Return Value
Type:
ActionResult<MapDataInfoSvgData>The operation completed successfully. The payload contains a
MapDataInfoSvgData object.
See Also