Skip to content

GroupBroadWorksAnywhereAddInstanceRequest

Bases: OCIRequest

Add a BroadWorks Anywhere instance to a group. The domain is required in the serviceUserId. The following elements are only used in AS data mode: networkClassOfService The response is either SuccessResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

service_user_id (str):

service_instance_profile (ServiceInstanceAddProfile):

broad_works_anywhere_scope (str):

prompt_for_clid (str):

silent_prompt_mode (bool):

prompt_for_passcode (bool):

network_class_of_service (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupBroadWorksAnywhereAddInstanceRequest(OCIRequest):
    """Add a BroadWorks Anywhere instance to a group.
        The domain is required in the serviceUserId.
        The following elements are only used in AS data mode:
          networkClassOfService
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        service_user_id (str):

        service_instance_profile (ServiceInstanceAddProfile):

        broad_works_anywhere_scope (str):

        prompt_for_clid (str):

        silent_prompt_mode (bool):

        prompt_for_passcode (bool):

        network_class_of_service (Optional[str]):

    """

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

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

    service_user_id: str = field(metadata={"alias": "serviceUserId"})

    service_instance_profile: ServiceInstanceAddProfile = field(
        metadata={"alias": "serviceInstanceProfile"}
    )

    broad_works_anywhere_scope: str = field(
        metadata={"alias": "broadWorksAnywhereScope"}
    )

    prompt_for_clid: str = field(metadata={"alias": "promptForCLID"})

    silent_prompt_mode: bool = field(metadata={"alias": "silentPromptMode"})

    prompt_for_passcode: bool = field(metadata={"alias": "promptForPasscode"})

    network_class_of_service: Optional[str] = field(
        default=None, metadata={"alias": "networkClassOfService"}
    )

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupBroadWorksAnywhereAddInstanceRequest

client = Client()

command = GroupBroadWorksAnywhereAddInstanceRequest(
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    broad_works_anywhere_scope=...,
    prompt_for_clid=...,
    silent_prompt_mode=...,
    prompt_for_passcode=...,
    network_class_of_service=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupBroadWorksAnywhereAddInstanceRequest",
    service_provider_id=...,
    group_id=...,
    service_user_id=...,
    service_instance_profile=...,
    broad_works_anywhere_scope=...,
    prompt_for_clid=...,
    silent_prompt_mode=...,
    prompt_for_passcode=...,
    network_class_of_service=...,
)

print(response)