/icws/{sessionId}/configuration/access-control-groups/assignable/{objectType}

GET

/icws/{sessionId}/configuration/access-control-groups/assignable/{objectType}

Gets a list of ACG's that the provided user can assign objects of the provided type to.
Feature Version
configuration 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
        objectType

        Required

        The object type to be queried. The value shall be one of the following:

        • account-code
        • client-configuration-template
        • managed-phone-registration-group
        • managed-phone-ring-set
        • keyword-set
        • location
        • Show More

          Query
          id
          The id of the user for this function. If the id is not provided then logged in user id will be used.

            Response

            200 - OK
            The assignableResult resource is included in the response.
            assignableResult
            Represent a result object returned by assignable function.
            Property
            Value
            Comments
            id
            String

            Required

            The unique identifier used to reference this configuration object.
            displayName
            String
            The display name of this configuration object.

            This property can be null.

            uri
            Uri
            A URI used to access this configuration object.
            children
            List [Unbounded]: Complex Type: assignableAccessControlGroup

            Recursive

            This property can be null.

            Property type documentation:

            Represents the children of an Access Control Group that the logged-in user can assign objects to.

            List item type documentation:

            Represents an Access Control Group and it's children that the logged-in user can assign objects to.

            400 - Bad Request
            Invalid request was provided.

            Error Responses

            Error Identifier
            Error Type
            Error Description
            error.request.invalidRepresentation.malformed
            Type: urn:inin.com:common:error
            The request representation object was malformed.
            Feature Version
            configuration 2
            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.
            403 - Forbidden
            Not authorized to create these resources.
            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 Responses

            Error Identifier
            Error Type
            Error Description
            error.request.internalServerError
            Type: urn:inin.com:common:error
            The server encountered an unexpected, internal error.
            Feature Version
            configuration 2
            error.request.timeout
            Type: urn:inin.com:common:error
            The request timed out.
            Feature Version
            configuration 2
            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.