GroupRoutePointGetInstanceListRequest

Bases: OCIRequest

Get a list of Route Point instances within a group. It is possible to search by various criteria to restrict the number of rows returned. The response is either GroupRoutePointGetInstanceListResponse 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_route_point_name (Optional[List[SearchCriteriaRoutePointName]]):

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

@dataclass(kw_only=True)
class GroupRoutePointGetInstanceListRequest(OCIRequest):
    """Get a list of Route Point instances within a group.
        It is possible to search by various criteria to restrict the number of rows returned.
        The response is either GroupRoutePointGetInstanceListResponse 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_route_point_name (Optional[List[SearchCriteriaRoutePointName]]):

    """

    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_route_point_name: Optional[List[SearchCriteriaRoutePointName]] = (
        field(default=None, metadata={"alias": "searchCriteriaRoutePointName"})
    )

Responses

Bases: OCIDataResponse

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

Attributes:

route_point_table (OCITable):

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

@dataclass(kw_only=True)
class GroupRoutePointGetInstanceListResponse(OCIDataResponse):
    """Response to the GroupRoutePointGetInstanceListRequest.
        Contains a table with column headings:
        \"Service User Id\", \"Name\", \"Video\", \"Phone Number\", \"Extension\", \"Department\", \"Is Active\".
        The column values for \"Video\" and \"Is Active\" can either be true, or false.

    Attributes:

        route_point_table (OCITable):

    """

    route_point_table: OCITable = field(metadata={"alias": "routePointTable"})

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 GroupRoutePointGetInstanceListRequest

client = Client()

command = GroupRoutePointGetInstanceListRequest(
    service_provider_id=...,
    group_id=...,
    group_department_name=...,
    response_size_limit=...,
    search_criteria_route_point_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupRoutePointGetInstanceListRequest",
    service_provider_id=...,
    group_id=...,
    group_department_name=...,
    response_size_limit=...,
    search_criteria_route_point_name=...,
)

print(response)