Expand All Collapse All

/icws/widgets/handler-notification

POST

/icws/widgets/handler-notification

Sends a notification to the Widgets custom handler that is watching for the objectId and eventId pair on their initiator.

This resource method is equivalent to IceLib's ININ.IceLib.Connection.Extensions.CustomNotification.SendServerRequestNoResponse with ServerNotification specified in the CustomMessageHeader.CustomMessageType property.

Feature Version
widgets 2

Request

This request has no parameters.
Representations
handlerNotificationRequest
Expand AllCollapse All
Property
Value
Comments
eventId
String

Required

The identifier of the event for the handler notification.

response
Boolean

Indicates whether the custom notification should return a response with this request.

data
String
A list of strings to be passed to the custom handler(s) that are configured to listen for this notification.
timeout
Int

Number of seconds to wait for the request to complete.

Response

202 - Accepted
The request to execute the widget handler was successfully received.
Associated Message
If the executed method for the widget handler returns data, the response will contain the data, otherwise the response will be empty.
handlerNotificationResponse
An object representing a request to execute a widget handler.
Expand AllCollapse All
Property
Value
Comments
executeResult
String

Required

A string that contains the result (if any) from the execution of the associated eventName with the widget handler.

400 - Bad Request
An error occurred while attempting to execute the widgets handler.
error
Provides additional detail for an error.
Expand AllCollapse All
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.
403 - Forbidden
Forbidden.
error
Provides additional detail for an error.
Expand AllCollapse All
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.
500 - Internal Server Error
Internal Server Error.
error
Provides additional detail for an error.
Expand AllCollapse All
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.
410 - Gone
This resource has been deprecated and removed from the API.
error
Provides additional detail for an error.
Expand AllCollapse All
Property
Value
Comments
errorId
String
The error identifier that describes the current error.
message
String

Required

A message that describes the current error.