Skip to content

ServiceProviderEndpointGetListRequest

Bases: OCIRequest

Request to search endpoints in the service provider/enterprise. The response is either ServiceProviderEndpointGetListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

response_size_limit (Optional[int]):

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_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):
Source code in src/mercury_ocip/commands/commands.py 
66889
66890
66891
66892
66893
66894
66895
66896
66897
66898
66899
66900
66901
66902
66903
66904
66905
66906
66907
66908
66909
66910
66911
66912
66913
66914
66915
66916
66917
66918
66919
66920
66921
66922
66923
66924
66925
66926
66927
66928
66929
66930
66931
66932
66933
66934
66935
66936
66937
66938
66939
66940
66941
66942
66943
66944
66945
66946
66947
66948
66949
66950
66951
66952
66953
66954
66955
66956
66957
66958
66959
66960
66961
66962
66963
66964
66965
66966
66967
66968
66969
66970
66971
66972
66973
66974
66975
66976
66977
66978
66979
66980
66981
66982
66983
66984
@dataclass(kw_only=True)
class ServiceProviderEndpointGetListRequest(OCIRequest):
    """Request to search endpoints in the service provider/enterprise.
        The response is either ServiceProviderEndpointGetListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        response_size_limit (Optional[int]):

        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_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_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_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

Responses

Bases: OCIDataResponse

Response to ServiceProviderEndpointGetListRequest. The column headings for the endpointTable are: "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". Possible values for User Type are "User", "CCBasic", "CCStandard", "CCPremium", "RP", "MOH", "MOHVideo".

Attributes:

endpoint_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py 
133961
133962
133963
133964
133965
133966
133967
133968
133969
133970
133971
133972
133973
133974
@dataclass(kw_only=True)
class ServiceProviderEndpointGetListResponse(OCIDataResponse):
    """Response to ServiceProviderEndpointGetListRequest.
        The column headings for the endpointTable are:
          \"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\".
                Possible values for User Type are \"User\", \"CCBasic\", \"CCStandard\", \"CCPremium\", \"RP\", \"MOH\", \"MOHVideo\".

    Attributes:

        endpoint_table (OCITable):

    """

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

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py 
115
116
117
118
119
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 ServiceProviderEndpointGetListRequest

client = Client()

command = ServiceProviderEndpointGetListRequest(
    service_provider_id=...,
    response_size_limit=...,
    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_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("ServiceProviderEndpointGetListRequest",
    service_provider_id=...,
    response_size_limit=...,
    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_exact_user_department=...,
)

print(response)