Skip to content

EnterpriseEnterpriseTrunkGetAvailableUserListRequest

Bases: OCIRequest

Request the list of users that are available to be added to an enterprise trunk. This list contains users in the enterprise that are trunk users and not already assigned to 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 an EnterpriseEnterpriseTrunkGetAvailableUserListResponse or an ErrorResponse.

Attributes:

service_provider_id (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]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseEnterpriseTrunkGetAvailableUserListRequest(OCIRequest):
    """Request the list of users that are available to be added to an enterprise trunk.  This list contains users in the enterprise that are trunk users and not already assigned to 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 an EnterpriseEnterpriseTrunkGetAvailableUserListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (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]):

    """

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

    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"})

Responses

Bases: OCIDataResponse

Response to EnterpriseEnterpriseTrunkGetAvailableUserListRequest. The column headings for the enterpriseTrunkUserTable are: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".

Attributes:

user_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseEnterpriseTrunkGetAvailableUserListResponse(OCIDataResponse):
    """Response to EnterpriseEnterpriseTrunkGetAvailableUserListRequest.
        The column headings for the enterpriseTrunkUserTable are: \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
        \"Phone Number\", \"Extension\", \"Department\", \"Email Address\".

    Attributes:

        user_table (OCITable):

    """

    user_table: OCITable = field(metadata={"alias": "userTable"})

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 EnterpriseEnterpriseTrunkGetAvailableUserListRequest

client = Client()

command = EnterpriseEnterpriseTrunkGetAvailableUserListRequest(
    service_provider_id=...,
    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=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseEnterpriseTrunkGetAvailableUserListRequest",
    service_provider_id=...,
    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=...,
)

print(response)