Expand All Collapse All

/icws/{sessionId}/alerts/memos

Feature Version
statistics 6

POST

/icws/{sessionId}/alerts/memos

Creates a memo for all listeners.

Feature Version
statistics 6

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
        createMemoRequest
        Expand AllCollapse All
        Property
        Value
        Comments
        userIds
        List [1,*]: String
        List of IDs for users that are targets.
        workgroups
        List [1,*]: String
        List of IDs for workgroups that are targets.
        iconFileName
        String
        The name of the icon file that will be uploaded and associated with this memo. If this property is included, the response will contain an upload URI. ICWS only has support for *.ico files. If any other file type is uploaded, the uploaded file will be discarded, and the created memo's icon property will remain un-set.
        expiration
        DateTime
        The memo's expiration date and time.
        memoTitle
        String
        The title of the memo.
        memoBody
        String
        The body of the memo.
        desktopAlert
        0
        The memo will be displayed as a desktop alert.
        notificationArea
        1
        The memo will be displayed in the client's notification area.
        information
        0
        The information sound that should be played with this memo.
        warning
        1
        The warning sound that should be played with this memo.
        error
        2
        The error sound that should be played with this memo.
        iconUri
        Uri

        The location where the icon file associated with this memo can be downloaded. This URI will be of the form /SessionManagerFileTransfer/alerts/memo/icon/{sessionId}/{memoIconFileName}.

        Memo icon downloads require an active ICWS session as the sessionId. ICO and PNG are the only supported memo icon file formats. The desired file extension (*.ico or *.png respectively) should be appended to the URI prior to the request to control which format is returned. Requests without an extension will assume PNG.

        Requests for PNG memo icons support an optional iconSize parameter to control the size of the returned PNG. For example, to request a 16px by 16px PNG, the URL would end in /memoIconFilename.png?iconSize=16. The default iconSize is 32 without this parameter.

        url
        String
        A URL for the memo. This property is not guaranteed to be a properly-formatted URL string.

        Response

        201 - Created

        The memo has been created.

        createMemoResponse
        Expand AllCollapse All
        Property
        Value
        Comments
        memoId
        String

        Required

        The identifier for the created memo.
        iconUploadUri
        Uri
        If the memo request included an iconFileName, a URI to upload the *.ico file will be returned in this property.
        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.
        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.
        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.
          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.
          500 - Internal Server Error
          An unexpected error occurred while processing the request.
          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.