EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest

Bases: OCIRequest

Request the list of Virtual On-Net users in an Enterprise. 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 EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse 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_group_location_code (Optional[List[SearchCriteriaGroupLocationCode]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_exact_virtual_on_net_call_type_name (Optional[SearchCriteriaExactVirtualOnNetCallTypeName]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest(OCIRequest):
    """Request the list of Virtual On-Net users in an Enterprise.
        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  EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse 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_group_location_code (Optional[List[SearchCriteriaGroupLocationCode]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_exact_virtual_on_net_call_type_name (Optional[SearchCriteriaExactVirtualOnNetCallTypeName]):

    """

    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_group_location_code: Optional[
        List[SearchCriteriaGroupLocationCode]
    ] = field(default=None, metadata={"alias": "searchCriteriaGroupLocationCode"})

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

    search_criteria_exact_virtual_on_net_call_type_name: Optional[
        SearchCriteriaExactVirtualOnNetCallTypeName
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactVirtualOnNetCallTypeName"}
    )

Responses

Bases: OCIDataResponse

Response to EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest. Contains a table with column headings : "Group Id", "Last Name", "First Name", "Phone Number", "Extension", "Virtual On-Net Call Type" in a row for each user.

Attributes:

user_table (OCITable):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListResponse(OCIDataResponse):
    """Response to   EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest.
        Contains a table with column headings : \"Group Id\", \"Last Name\", \"First Name\", \"Phone Number\", \"Extension\",
        \"Virtual On-Net Call Type\" in a row for each user.

    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 EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest

client = Client()

command = EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest(
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_group_location_code=...,
    search_criteria_extension=...,
    search_criteria_exact_virtual_on_net_call_type_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("EnterpriseVirtualOnNetEnterpriseExtensionsGetUserListRequest",
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_group_location_code=...,
    search_criteria_extension=...,
    search_criteria_exact_virtual_on_net_call_type_name=...,
)

print(response)