GroupAccessDeviceGetAvailableDetailListRequest19

Bases: OCIRequest

Requests the list of available access devices for assignment to a user within a group. The list includes devices created at the system, service provider, and group levels.

The following elements are used in AS mode and ignored in XS data mode:
  onlyIntelligentDevice

The response is either GroupAccessDeviceGetAvailableDetailListResponse19 or
ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

is_music_on_hold (bool):

only_video_capable (bool):

only_intelligent_device (Optional[bool]):

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

@dataclass(kw_only=True)
class GroupAccessDeviceGetAvailableDetailListRequest19(OCIRequest):
    """Requests the list of available access devices for assignment to a user
        within a group. The list includes devices created at the system, service provider, and group levels.

        The following elements are used in AS mode and ignored in XS data mode:
          onlyIntelligentDevice

        The response is either GroupAccessDeviceGetAvailableDetailListResponse19 or
        ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        is_music_on_hold (bool):

        only_video_capable (bool):

        only_intelligent_device (Optional[bool]):

    """

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

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

    is_music_on_hold: bool = field(metadata={"alias": "isMusicOnHold"})

    only_video_capable: bool = field(metadata={"alias": "onlyVideoCapable"})

    only_intelligent_device: Optional[bool] = field(
        default=None, metadata={"alias": "onlyIntelligentDevice"}
    )

Responses

Bases: OCIDataResponse

Response to GroupAccessDeviceGetAvailableDetailListRequest19.

Attributes:

available_access_device (Optional[List[object]]):

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

@dataclass(kw_only=True)
class GroupAccessDeviceGetAvailableDetailListResponse19(OCIDataResponse):
    """Response to GroupAccessDeviceGetAvailableDetailListRequest19.

    Attributes:

        available_access_device (Optional[List[object]]):

    """

    available_access_device: Optional[List[object]] = field(
        default=None, metadata={"alias": "availableAccessDevice"}
    )

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 GroupAccessDeviceGetAvailableDetailListRequest19

client = Client()

command = GroupAccessDeviceGetAvailableDetailListRequest19(
    service_provider_id=...,
    group_id=...,
    is_music_on_hold=...,
    only_video_capable=...,
    only_intelligent_device=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceGetAvailableDetailListRequest19",
    service_provider_id=...,
    group_id=...,
    is_music_on_hold=...,
    only_video_capable=...,
    only_intelligent_device=...,
)

print(response)