Skip to content

GroupDnGetAssignmentPagedSortedListRequest

Bases: OCIRequest

Get the list of assigned and unassigned DNs in a group. Each DN can be assigned to a user and/or department. Ranges of DNs with identical assignment and activation properties are coalesced to a single table row entry. Dns assigned to the IMRN pool are not listed in the response. 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. If no sortOrder is included the response is sorted by Phone Number by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criterion are logically ORed together.

The department in both the search criteria and sort by fields refer to the department to which
the dn belongs.

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.

The response is either a GroupDnGetAssignmentPagedSortedListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupDnGetAssignmentPagedSortedList]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):

search_criteria_exact_dn_availability (Optional[SearchCriteriaExactDnAvailability]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_exact_user_type (Optional[List[SearchCriteriaExactUserType]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupDnGetAssignmentPagedSortedListRequest(OCIRequest):
    """Get the list of assigned and unassigned DNs in a group. Each DN can be assigned
        to a user and/or department. Ranges of DNs with identical assignment and activation properties
        are coalesced to a single table row entry.
        Dns assigned to the IMRN pool are not listed in the response.
        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.
        If no sortOrder is included the response is sorted by Phone Number by default.
        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included.
        Then the search criterion are logically ORed together.

        The department in both the search criteria and sort by fields refer to the department to which
        the dn belongs.

        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.

        The response is either a GroupDnGetAssignmentPagedSortedListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupDnGetAssignmentPagedSortedList]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):

        search_criteria_exact_dn_availability (Optional[SearchCriteriaExactDnAvailability]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_exact_user_type (Optional[List[SearchCriteriaExactUserType]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

        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[SortOrderGroupDnGetAssignmentPagedSortedList]] = field(
        default=None, metadata={"alias": "sortOrder"}
    )

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

    search_criteria_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

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

    search_criteria_exact_dn_availability: Optional[
        SearchCriteriaExactDnAvailability
    ] = field(default=None, metadata={"alias": "searchCriteriaExactDnAvailability"})

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

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

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

    search_criteria_exact_user_type: Optional[List[SearchCriteriaExactUserType]] = (
        field(default=None, metadata={"alias": "searchCriteriaExactUserType"})
    )

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

    search_criteria_email_address: Optional[List[SearchCriteriaEmailAddress]] = field(
        default=None, metadata={"alias": "searchCriteriaEmailAddress"}
    )

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

Responses

Bases: OCIDataResponse

Response to the GroupDnGetAssignmentPagedSortedListRequest.

The response contains a table with columns: "Phone Numbers", "Department", "Department Type",
"Parent Department", "Parent Department Type", "Activated", "Available", "User Id",
"Last Name", "First Name", "Extension", "Email Address", "User Type", "Country Code", "National Prefix".
The "Phone Numbers" column contains either a single DN or a range of DNs.
The "User Id", "Last Name" and "First Name" columns contains the corresponding attributes of the user possessing the DN(s).
For a service instance, "Last Name" contains the service instance name and "First Name" column contains the corresponding enumerated UserType value.
The "Department" column contains the department of the DN, not the department of the user or service instance.
The "Department Type" and "Parent Department Type" columns will contain the values "Enterprise" or "Group".
The "Activated" column indicates if the DN or DN range has been activated.  Only has a value if the DN(s) is assigned to a user.
The "User Type" column contains the corresponding enumerated UserType value.
The "Country Code" column indicates the dialing prefix for the phone number.
The "National Prefix" column indicates the digit sequence to be dialed before the telephone number.
NOTE: the same phone number can show up in the list twice if the phone number is being used as the group calling line Id.

Attributes:

dn_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupDnGetAssignmentPagedSortedListResponse(OCIDataResponse):
    """Response to the GroupDnGetAssignmentPagedSortedListRequest.

        The response contains a table with columns: \"Phone Numbers\", \"Department\", \"Department Type\",
        \"Parent Department\", \"Parent Department Type\", \"Activated\", \"Available\", \"User Id\",
        \"Last Name\", \"First Name\", \"Extension\", \"Email Address\", \"User Type\", \"Country Code\", \"National Prefix\".
        The \"Phone Numbers\" column contains either a single DN or a range of DNs.
        The \"User Id\", \"Last Name\" and \"First Name\" columns contains the corresponding attributes of the user possessing the DN(s).
        For a service instance, \"Last Name\" contains the service instance name and \"First Name\" column contains the corresponding enumerated UserType value.
        The \"Department\" column contains the department of the DN, not the department of the user or service instance.
        The \"Department Type\" and \"Parent Department Type\" columns will contain the values \"Enterprise\" or \"Group\".
        The \"Activated\" column indicates if the DN or DN range has been activated.  Only has a value if the DN(s) is assigned to a user.
        The \"User Type\" column contains the corresponding enumerated UserType value.
        The \"Country Code\" column indicates the dialing prefix for the phone number.
        The \"National Prefix\" column indicates the digit sequence to be dialed before the telephone number.
        NOTE: the same phone number can show up in the list twice if the phone number is being used as the group calling line Id.

    Attributes:

        dn_table (OCITable):

    """

    dn_table: OCITable = field(metadata={"alias": "dnTable"})

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 GroupDnGetAssignmentPagedSortedListRequest

client = Client()

command = GroupDnGetAssignmentPagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_dn=...,
    search_criteria_department_name=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_exact_dn_availability=...,
    search_criteria_user_id=...,
    search_criteria_user_first_name=...,
    search_criteria_user_last_name=...,
    search_criteria_exact_user_type=...,
    search_criteria_extension=...,
    search_criteria_email_address=...,
    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("GroupDnGetAssignmentPagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_dn=...,
    search_criteria_department_name=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_exact_dn_availability=...,
    search_criteria_user_id=...,
    search_criteria_user_first_name=...,
    search_criteria_user_last_name=...,
    search_criteria_exact_user_type=...,
    search_criteria_extension=...,
    search_criteria_email_address=...,
    search_criteria_mode_or=...,
)

print(response)