/icws/{sessionId}/activations/workgroups

GET

/icws/{sessionId}/activations/workgroups

Get the current workgroup activations for one or more workgroups. If only one workgroup's activations are desired, consider using /service/activations/workgroup/{workgroupID}.
Feature Version
activations 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.

        Query
        select

        Required

        A comma delimited list of workgroup IDs to retrieve workgroup activations for.

        Example: select=Marketing,Support

          Query
          filter

          A comma delimited list of user IDs to explicitly retrieve activations for with respect to this workgroup or workgroups. If this parameter is specified, only activations for the users listed here will be included in the response.

          Example: filter=Rhonda.Gibson,Marc.Varner

            Response

            200 - OK
            The selected workgroups' activations are included in the entity body. Within each workgroupActivationSet, the activations dictionary is a mapping from user IDs to booleans: true if the user is currently activated on the workgroup, and false if not. Any workgroups that do not exist will not be included in the response.
            workgroupActivationSets
            Property
            Value
            Comments
            workgroupId
            String

            Required

            List of IDs for workgroups that are targets.
            [key]
            String

            Required

            The key identifying this pair.
            [value]
            Boolean

            Required

            The value of this pair.
            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.