/icws/{sessionId}/system/handler-notification

POST

/icws/{sessionId}/system/handler-notification

Sends a notification to one or more custom handlers that are watching for the objectId and eventId pair on their initiator.

Due to the nature of custom handlers, the server does not provide any guarantee that the notification is handled or results in any side-effects.

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

Feature Version
system 1

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Representations
        handlerNotification
        Property
        Value
        Comments
        objectId
        String

        Required

        The identifier of the object for the handler notification.

        The value represented by this property should be treated as case-insensitive.

        eventId
        String

        Required

        The identifier of the event for the handler notification.

        The value represented by this property should be treated as case-insensitive.

        data
        List [Unbounded]: String

        Required

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

        Response

        202 - Accepted

        The server has accepted the notification.

        Due to the nature of custom handlers, the server does not provide any guarantee that the notification is handled by a handler or results in any side-effects.

        400 - Bad Request
        The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
        error
        Provides additional detail for an error.
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        401 - Unauthorized
        The specified session token is missing, invalid, or has expired.
        Parameters
        Type
        Name
        Comments
        Header
        WWW-Authenticate

        Required

        Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

        WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

          error
          Provides additional detail for an error.
          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.
          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
          An unexpected error occurred while processing the request.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.