GroupExistingUsersUnassignUserServiceListRequest

Bases: OCIRequest

Requests to unassign the user services and service packs for all existing users within the group. BroadSoft recommends using this command only for small groups with less than 100 users. This command will return an error if the group has over 500 users. The recommended way to bulk assign/unassign services is Service Pack Migration. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

service_name (Optional[List[str]]):

service_pack_name (Optional[List[str]]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupExistingUsersUnassignUserServiceListRequest(OCIRequest):
    """Requests to unassign the user services and service packs for all existing users within the group.
        BroadSoft recommends using this command only for small groups with less than 100 users.  This
        command will return an error if the group has over 500 users.  The recommended way to bulk
        assign/unassign services is Service Pack Migration.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_name (Optional[List[str]]):

        service_pack_name (Optional[List[str]]):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    service_name: Optional[List[str]] = field(
        default=None, metadata={"alias": "serviceName"}
    )

    service_pack_name: Optional[List[str]] = field(
        default=None, metadata={"alias": "servicePackName"}
    )

Responses

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import GroupExistingUsersUnassignUserServiceListRequest

client = Client()

command = GroupExistingUsersUnassignUserServiceListRequest(
    service_provider_id=...,
    group_id=...,
    service_name=...,
    service_pack_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupExistingUsersUnassignUserServiceListRequest",
    service_provider_id=...,
    group_id=...,
    service_name=...,
    service_pack_name=...,
)

print(response)