/icws/{sessionId}/activations/workgroups/{workgroupId}

GET

/icws/{sessionId}/activations/workgroups/{workgroupId}

Get the current workgroup activations for a single workgroup.
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.

        Template
        workgroupId

        Required

        The ID the workgroup whose users' activations are being retrieved or subscribed to.

          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 workgroups's activations are included in the entity body. 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.
            workgroupActivationSet
            Represents the current activation state for the members of a single workgroup. Keys here are user IDs and values are booleans (true for activated, false for not activated).
            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.
            403 - Forbidden
            The session user does not have permission to query activations for this workgroup.
            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.
            404 - Not Found
            The workgroup does not exist.
            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.
            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.

              PUT

              /icws/{sessionId}/activations/workgroups/{workgroupId}

              Sets current activations for a single workgroup. Keys in the request object should be user IDs, and values should be booleans indicating whether or not the user should be activated on this workgroup.
              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.

                    Template
                    workgroupId

                    Required

                    The ID the workgroup whose users' activations are being retrieved or subscribed to.

                      Representations
                      workgroupActivationDelta
                      Represents a set of changes to a workgroup's activations. Keys are user IDs and values are booleans (true for activated, false for not activated).
                      Property
                      Value
                      Comments
                      [key]
                      String

                      Required

                      The key identifying this pair.
                      [value]
                      Boolean

                      Required

                      The value of this pair.

                      Response

                      200 - OK
                      The workgroup's activations are included in the message body.
                      workgroupActivationSet
                      Represents the current activation state for the members of a single workgroup. Keys here are user IDs and values are booleans (true for activated, false for not activated).
                      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.
                      403 - Forbidden
                      The session user does not have permission to change the specified activations.
                      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.
                      400 - Bad Request
                      This may indicate malformed syntax or that the specified workgroup does not exist.
                      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.