Skip to content

SystemEndpointGetListRequest

Bases: OCIRequest

Request to search endpoints in the system. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All endpoints in the administrator's reseller meeting the search criteria are returned.

The response is either SystemEndpointGetListResponse or ErrorResponse.

The following data elements are only used in AS data mode:
  searchCriteriaResellerId

Attributes:

response_size_limit (Optional[int]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_line_port_user_part (Optional[List[SearchCriteriaLinePortUserPart]]):

search_criteria_line_port_domain (Optional[List[SearchCriteriaLinePortDomain]]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_device_type (Optional[List[SearchCriteriaDeviceType]]):

search_criteria_device_name (Optional[List[SearchCriteriaDeviceName]]):

search_criteria_device_mac_address (Optional[List[SearchCriteriaDeviceMACAddress]]):

search_criteria_device_net_address (Optional[List[SearchCriteriaDeviceNetAddress]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemEndpointGetListRequest(OCIRequest):
    """Request to search endpoints in the system.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. All endpoints
        in the administrator's reseller meeting the search criteria are returned.

        The response is either SystemEndpointGetListResponse or ErrorResponse.

        The following data elements are only used in AS data mode:
          searchCriteriaResellerId

    Attributes:

        response_size_limit (Optional[int]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_line_port_user_part (Optional[List[SearchCriteriaLinePortUserPart]]):

        search_criteria_line_port_domain (Optional[List[SearchCriteriaLinePortDomain]]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_device_type (Optional[List[SearchCriteriaDeviceType]]):

        search_criteria_device_name (Optional[List[SearchCriteriaDeviceName]]):

        search_criteria_device_mac_address (Optional[List[SearchCriteriaDeviceMACAddress]]):

        search_criteria_device_net_address (Optional[List[SearchCriteriaDeviceNetAddress]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

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

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

    search_criteria_exact_organization_type: Optional[
        SearchCriteriaExactOrganizationType
    ] = field(default=None, metadata={"alias": "searchCriteriaExactOrganizationType"})

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

    search_criteria_line_port_user_part: Optional[
        List[SearchCriteriaLinePortUserPart]
    ] = field(default=None, metadata={"alias": "searchCriteriaLinePortUserPart"})

    search_criteria_line_port_domain: Optional[List[SearchCriteriaLinePortDomain]] = (
        field(default=None, metadata={"alias": "searchCriteriaLinePortDomain"})
    )

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

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

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

    search_criteria_device_type: Optional[List[SearchCriteriaDeviceType]] = field(
        default=None, metadata={"alias": "searchCriteriaDeviceType"}
    )

    search_criteria_device_name: Optional[List[SearchCriteriaDeviceName]] = field(
        default=None, metadata={"alias": "searchCriteriaDeviceName"}
    )

    search_criteria_device_mac_address: Optional[
        List[SearchCriteriaDeviceMACAddress]
    ] = field(default=None, metadata={"alias": "searchCriteriaDeviceMACAddress"})

    search_criteria_device_net_address: Optional[
        List[SearchCriteriaDeviceNetAddress]
    ] = field(default=None, metadata={"alias": "searchCriteriaDeviceNetAddress"})

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

Responses

Bases: OCIDataResponse

Response to SystemEndpointGetListRequest. The column headings for the endpointTable are: "Organization Id", "Organization Type", "Group Id", "Line/Port", "Last Name","First Name", "User Id", "User Type", "Phone Number", "Extension", "Device Type", "Device Name", "Net Address", "MAC Address", "Department", "Email Address", "Reseller Id". Possible values for User Type are "User", "CCBasic", "CCStandard", "CCPremium", "RP", "MOH", "MOHVideo".

The following columns are only returned in AS data mode:
  "Reseller Id"

Attributes:

endpoint_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemEndpointGetListResponse(OCIDataResponse):
    """Response to SystemEndpointGetListRequest.
        The column headings for the endpointTable are: \"Organization Id\", \"Organization Type\", \"Group Id\", \"Line/Port\", \"Last Name\",\"First Name\", \"User Id\", \"User Type\", \"Phone Number\", \"Extension\", \"Device Type\", \"Device Name\", \"Net Address\", \"MAC Address\", \"Department\", \"Email Address\", \"Reseller Id\".
        Possible values for User Type are \"User\", \"CCBasic\", \"CCStandard\", \"CCPremium\", \"RP\", \"MOH\", \"MOHVideo\".

        The following columns are only returned in AS data mode:
          \"Reseller Id\"

    Attributes:

        endpoint_table (OCITable):

    """

    endpoint_table: OCITable = field(metadata={"alias": "endpointTable"})

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 SystemEndpointGetListRequest

client = Client()

command = SystemEndpointGetListRequest(
    response_size_limit=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_organization_type=...,
    search_criteria_group_id=...,
    search_criteria_line_port_user_part=...,
    search_criteria_line_port_domain=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_device_type=...,
    search_criteria_device_name=...,
    search_criteria_device_mac_address=...,
    search_criteria_device_net_address=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemEndpointGetListRequest",
    response_size_limit=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_organization_type=...,
    search_criteria_group_id=...,
    search_criteria_line_port_user_part=...,
    search_criteria_line_port_domain=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
    search_criteria_device_type=...,
    search_criteria_device_name=...,
    search_criteria_device_mac_address=...,
    search_criteria_device_net_address=...,
    search_criteria_reseller_id=...,
)

print(response)