Expand All Collapse All

/icws/{sessionId}/status/user-status-previous-info/{userId}

GET

/icws/{sessionId}/status/user-status-previous-info/{userId}

Retrieves specified user's previous status info for all applicable statuses. Status previous info is not a log of a user's status history.

Status previous info can be useful for pre-filling previous values for notes and forwardNumber when a User is setting a status, so that old status info can be pre-populated into a dialog.

Feature Version
status 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.

        Template
        userId

        Required

        The ID of the user resource.

          Response

          200 - OK

          The specified user's previous status info representations are in the entity body. The order of items in the response is not chronological.

          Additionally, there will be only one previous status info record for each statusId that the specified user has stored extra information for.

          userStatusPreviousInfos
          Expand AllCollapse All
          Property
          Value
          Comments
          statusId
          String

          Required

          Previous status message identifier defined from StatusMessageList.

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

          notes
          String

          Required

          Previous status notes.
          forwardNumber
          String
          Previous status forward number.
          204 - No Content
          There are no statuses for which the specified user has stored any extra information.
          404 - Not Found
          The specified user does not exist.
          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.
          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.