Skip to content

GroupDnGetAssignmentListRequest18

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. The response is either a GroupDnGetAssignmentListResponse18 or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_size_limit (Optional[int]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_exact_dn_department (Optional[SearchCriteriaExactDnDepartment]):

search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupDnGetAssignmentListRequest18(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.
        The response is either a GroupDnGetAssignmentListResponse18 or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_size_limit (Optional[int]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_exact_dn_department (Optional[SearchCriteriaExactDnDepartment]):

        search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

    """

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

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

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

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

    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_dn_department: Optional[SearchCriteriaExactDnDepartment] = (
        field(default=None, metadata={"alias": "searchCriteriaExactDnDepartment"})
    )

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

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

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

Responses

Bases: OCIDataResponse

Response to the GroupDnGetAssignmentListRequest18. The response contains a table with columns: "Phone Numbers", "Department", "Activated", "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 "Activated" column indicates if the DN or DN range has been activated. 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 GroupDnGetAssignmentListResponse18(OCIDataResponse):
    """Response to the GroupDnGetAssignmentListRequest18.
        The response contains a table with columns: \"Phone Numbers\", \"Department\", \"Activated\", \"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 \"Activated\" column indicates if the DN or DN range has been activated.
        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 GroupDnGetAssignmentListRequest18

client = Client()

command = GroupDnGetAssignmentListRequest18(
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_dn=...,
    search_criteria_user_first_name=...,
    search_criteria_user_last_name=...,
    search_criteria_exact_dn_department=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_user_id=...,
    search_criteria_extension=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupDnGetAssignmentListRequest18",
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_dn=...,
    search_criteria_user_first_name=...,
    search_criteria_user_last_name=...,
    search_criteria_exact_dn_department=...,
    search_criteria_exact_dn_activation=...,
    search_criteria_user_id=...,
    search_criteria_extension=...,
)

print(response)