Skip to content

GroupFlexibleSeatingHostGetInstanceListRequest

Bases: OCIRequest

Get a list of flexible seating host instances within a group. The response is either GroupFlexibleSeatingHostGetInstanceListResponse or ErrorResponse. It is possible to get the instances within a specified department.

Attributes:

service_provider_id (str):

group_id (str):

group_department_name (Optional[str]):

response_size_limit (Optional[int]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_service_instance_name (Optional[List[SearchCriteriaServiceInstanceName]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupFlexibleSeatingHostGetInstanceListRequest(OCIRequest):
    """Get a list of flexible seating host instances within a group.
        The response is either GroupFlexibleSeatingHostGetInstanceListResponse or ErrorResponse.
        It is possible to get the instances within a specified department.

    Attributes:

        service_provider_id (str):

        group_id (str):

        group_department_name (Optional[str]):

        response_size_limit (Optional[int]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_service_instance_name (Optional[List[SearchCriteriaServiceInstanceName]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

    """

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

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

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

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

    search_criteria_service_instance_name: Optional[
        List[SearchCriteriaServiceInstanceName]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceInstanceName"})

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

Responses

Bases: OCIDataResponse

Response to the GroupFlexibleSeatingHostGetInstanceListRequest. Contains a table with column headings: "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active". The column value for "Is Active" can either be true, or false.

Attributes:

flexible_seating_host_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupFlexibleSeatingHostGetInstanceListResponse(OCIDataResponse):
    """Response to the GroupFlexibleSeatingHostGetInstanceListRequest.
        Contains a table with column headings:
        \"Service User Id\", \"Name\", \"Phone Number\", \"Extension\", \"Department\", \"Is Active\".
        The column value for \"Is Active\" can either be true, or false.

    Attributes:

        flexible_seating_host_table (OCITable):

    """

    flexible_seating_host_table: OCITable = field(
        metadata={"alias": "flexibleSeatingHostTable"}
    )

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 GroupFlexibleSeatingHostGetInstanceListRequest

client = Client()

command = GroupFlexibleSeatingHostGetInstanceListRequest(
    service_provider_id=...,
    group_id=...,
    group_department_name=...,
    response_size_limit=...,
    search_criteria_exact_user_department=...,
    search_criteria_service_instance_name=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupFlexibleSeatingHostGetInstanceListRequest",
    service_provider_id=...,
    group_id=...,
    group_department_name=...,
    response_size_limit=...,
    search_criteria_exact_user_department=...,
    search_criteria_service_instance_name=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
)

print(response)