Skip to content

GroupAutoAttendantGetInstancePagedSortedListRequest

Bases: OCIRequest

Get a list of Auto Attendant instances within a group. The response is either GroupAutoAttendantGetInstancePagedSortedListResponse or ErrorResponse. If no sortOrder is included the response is sorted by Name ascending by default.

A limitation to the search by DN activation exists when the Number Activation mode is set to
Off. In this case DNs not assigned to users are never returned by queries with the
"dnActivationSearchCriteria" included.

If the responsePagingControl element is not provided,
the paging startIndex will be set to 1 by default,
and the responsePageSize will be set to the maximum responsePageSize by
default.
Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
Then the search criteria are logically ORed together.

Attributes:

service_provider_id (str):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupAutoAttendantGetInstancePagedSortedList]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):

search_criteria_service_status (Optional[SearchCriteriaServiceStatus]):

search_criteria_exact_auto_attendant_type (Optional[SearchCriteriaExactAutoAttendantType]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAutoAttendantGetInstancePagedSortedListRequest(OCIRequest):
    """Get a list of Auto Attendant instances within a group.
        The response is either GroupAutoAttendantGetInstancePagedSortedListResponse or ErrorResponse.
        If no sortOrder is included the response is sorted by Name ascending by default.

        A limitation to the search by DN activation exists when the Number Activation mode is set to
        Off. In this case DNs not assigned to users are never returned by queries with the
        \"dnActivationSearchCriteria\" included.

        If the responsePagingControl element is not provided,
        the paging startIndex will be set to 1 by default,
        and the responsePageSize will be set to the maximum responsePageSize by
        default.
        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
        Then the search criteria are logically ORed together.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupAutoAttendantGetInstancePagedSortedList]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):

        search_criteria_service_status (Optional[SearchCriteriaServiceStatus]):

        search_criteria_exact_auto_attendant_type (Optional[SearchCriteriaExactAutoAttendantType]):

        search_criteria_mode_or (Optional[bool]):

    """

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

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

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_order: Optional[
        List[SortOrderGroupAutoAttendantGetInstancePagedSortedList]
    ] = field(default=None, metadata={"alias": "sortOrder"})

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

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

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

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

    search_criteria_exact_dn_activation: Optional[SearchCriteriaExactDnActivation] = (
        field(default=None, metadata={"alias": "searchCriteriaExactDnActivation"})
    )

    search_criteria_service_status: Optional[SearchCriteriaServiceStatus] = field(
        default=None, metadata={"alias": "searchCriteriaServiceStatus"}
    )

    search_criteria_exact_auto_attendant_type: Optional[
        SearchCriteriaExactAutoAttendantType
    ] = field(default=None, metadata={"alias": "searchCriteriaExactAutoAttendantType"})

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

Responses

Bases: OCIDataResponse

Response to the GroupAutoAttendantGetInstancePagedSortedListRequest. The response contains a table with columns: "Service User Id", "Name", "Phone Number", "Is Phone Number Activated", "Country Code", "National Prefix", "Extension", "Department", "Department Type", "Parent Department", "Parent Department Type", "Is Active", "Type". The column values for "Is Active" can either be true, or false. The column values for "Type" can either be Basic or Standard. The "Department Type" and "Parent Department Type" columns will contain the values "Enterprise" or "Group".

In XS Mode the value for the "Type" column will always be populated with Basic.

Attributes:

auto_attendant_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAutoAttendantGetInstancePagedSortedListResponse(OCIDataResponse):
    """Response to the GroupAutoAttendantGetInstancePagedSortedListRequest.
        The response contains a table with columns:
        \"Service User Id\", \"Name\", \"Phone Number\", \"Is Phone Number Activated\", \"Country Code\",
        \"National Prefix\", \"Extension\", \"Department\", \"Department Type\", \"Parent Department\",
        \"Parent Department Type\", \"Is Active\", \"Type\".
        The column values for \"Is Active\" can either be true, or false.
        The column values for \"Type\" can either be Basic or Standard.
        The \"Department Type\" and \"Parent Department Type\" columns will contain the values \"Enterprise\" or \"Group\".

        In XS Mode the value for the \"Type\" column will always be populated with Basic.

    Attributes:

        auto_attendant_table (OCITable):

    """

    auto_attendant_table: OCITable = field(metadata={"alias": "autoAttendantTable"})

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 GroupAutoAttendantGetInstancePagedSortedListRequest

client = Client()

command = GroupAutoAttendantGetInstancePagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_service_status=...,
    search_criteria_exact_auto_attendant_type=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAutoAttendantGetInstancePagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_user_id=...,
    search_criteria_user_last_name=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_service_status=...,
    search_criteria_exact_auto_attendant_type=...,
    search_criteria_mode_or=...,
)

print(response)