Skip to content

EnterpriseEnterpriseTrunkGetUserListRequest

Bases: OCIRequest

Request the list of users in an enterprise trunk. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The response is either a EnterpriseEnterpriseTrunkGetUserListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

enterprise_trunk_name (str):

response_size_limit (Optional[int]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_alternate_trunk_identity (Optional[List[SearchCriteriaAlternateTrunkIdentity]]):

search_criteria_alternate_trunk_identity_domain (Optional[List[SearchCriteriaAlternateTrunkIdentityDomain]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_exact_user_route_list_assigned (Optional[SearchCriteriaExactUserRouteListAssigned]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseEnterpriseTrunkGetUserListRequest(OCIRequest):
    """Request the list of users in an enterprise trunk.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together.
        The response is either a EnterpriseEnterpriseTrunkGetUserListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        enterprise_trunk_name (str):

        response_size_limit (Optional[int]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_alternate_trunk_identity (Optional[List[SearchCriteriaAlternateTrunkIdentity]]):

        search_criteria_alternate_trunk_identity_domain (Optional[List[SearchCriteriaAlternateTrunkIdentityDomain]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_exact_user_route_list_assigned (Optional[SearchCriteriaExactUserRouteListAssigned]):

    """

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

    enterprise_trunk_name: str = field(metadata={"alias": "enterpriseTrunkName"})

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

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

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

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

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

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

    search_criteria_alternate_trunk_identity: Optional[
        List[SearchCriteriaAlternateTrunkIdentity]
    ] = field(default=None, metadata={"alias": "searchCriteriaAlternateTrunkIdentity"})

    search_criteria_alternate_trunk_identity_domain: Optional[
        List[SearchCriteriaAlternateTrunkIdentityDomain]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaAlternateTrunkIdentityDomain"}
    )

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

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

    search_criteria_exact_user_route_list_assigned: Optional[
        SearchCriteriaExactUserRouteListAssigned
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactUserRouteListAssigned"}
    )

Responses

Bases: OCIDataResponse

Response to EnterpriseEnterpriseTrunkGetUserListRequest. The column headings for the enterpriseTrunkUserTable are: "Group Id", "User Id", "Last Name", "First Name", "Phone Number", "Alternate Trunk Identity", "Hiragana Last Name", "Hiragana First Name", "Extension", "Department", "Email Address" and "Route List Assigned".

Attributes:

enterprise_trunk_user_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseEnterpriseTrunkGetUserListResponse(OCIDataResponse):
    """Response to EnterpriseEnterpriseTrunkGetUserListRequest.
        The column headings for the enterpriseTrunkUserTable are: \"Group Id\", \"User Id\", \"Last Name\", \"First Name\", \"Phone Number\", \"Alternate Trunk Identity\", \"Hiragana Last Name\", \"Hiragana First Name\",
         \"Extension\", \"Department\", \"Email Address\" and \"Route List Assigned\".

    Attributes:

        enterprise_trunk_user_table (OCITable):

    """

    enterprise_trunk_user_table: OCITable = field(
        metadata={"alias": "enterpriseTrunkUserTable"}
    )

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 EnterpriseEnterpriseTrunkGetUserListRequest

client = Client()

command = EnterpriseEnterpriseTrunkGetUserListRequest(
    service_provider_id=...,
    enterprise_trunk_name=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_user_id=...,
    search_criteria_group_id=...,
    search_criteria_alternate_trunk_identity=...,
    search_criteria_alternate_trunk_identity_domain=...,
    search_criteria_extension=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_route_list_assigned=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseEnterpriseTrunkGetUserListRequest",
    service_provider_id=...,
    enterprise_trunk_name=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_user_id=...,
    search_criteria_group_id=...,
    search_criteria_alternate_trunk_identity=...,
    search_criteria_alternate_trunk_identity_domain=...,
    search_criteria_extension=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_route_list_assigned=...,
)

print(response)