NotificationController.QueryNotifications Method |
Gets multiple notifications.
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("Query")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(409)]
[ProducesResponseTypeAttribute(440)]
public ActionResult<IList<NotificationData>> QueryNotifications(
[FromBodyAttribute] QueryNotificationOptions options,
Guid? sessionId = null
)
<HttpPostAttribute("Query")>
<ProducesResponseTypeAttribute(403)>
<ProducesResponseTypeAttribute(405)>
<ProducesResponseTypeAttribute(409)>
<ProducesResponseTypeAttribute(440)>
Public Function QueryNotifications (
<FromBodyAttribute> options As QueryNotificationOptions,
Optional sessionId As Guid? = Nothing
) As ActionResult(Of IList(Of NotificationData))
public:
[HttpPostAttribute(L"Query")]
[ProducesResponseTypeAttribute(403)]
[ProducesResponseTypeAttribute(405)]
[ProducesResponseTypeAttribute(409)]
[ProducesResponseTypeAttribute(440)]
ActionResult<IList<NotificationData^>^>^ QueryNotifications(
[FromBodyAttribute] QueryNotificationOptions^ options,
Nullable<Guid> sessionId = nullptr
)
[<HttpPostAttribute("Query")>]
[<ProducesResponseTypeAttribute(403)>]
[<ProducesResponseTypeAttribute(405)>]
[<ProducesResponseTypeAttribute(409)>]
[<ProducesResponseTypeAttribute(440)>]
member QueryNotifications :
[<FromBodyAttribute>] options : QueryNotificationOptions *
?sessionId : Nullable<Guid>
(* Defaults:
let _sessionId = defaultArg sessionId null
*)
-> ActionResult<IList<NotificationData>>
Parameters
- options
- Type: Dundas.BI.WebApi.Models.QueryNotificationOptions
An object that carries all needed information about the notifications to be retrieved. - sessionId (Optional)
- Type: System.Nullable<Guid>
Current session ID.
Return Value
Type:
ActionResult<IList<NotificationData>>The operation completed successfully. The payload contains an array of
NotificationData objects.
See Also