Skip to content

GroupEndpointGetListRequest

Bases: OCIRequest

Request to search endpoints in the group. The response is either GroupEndpointGetListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_size_limit (Optional[int]):

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_fast/commands/commands.py 
46543
46544
46545
46546
46547
46548
46549
46550
46551
46552
46553
46554
46555
46556
46557
46558
46559
46560
46561
46562
46563
46564
46565
46566
46567
46568
46569
46570
46571
46572
46573
46574
46575
46576
46577
46578
46579
46580
46581
46582
46583
46584
46585
46586
46587
46588
46589
46590
46591
46592
46593
46594
46595
46596
46597
46598
46599
46600
46601
46602
46603
46604
46605
46606
46607
46608
46609
46610
46611
46612
46613
46614
46615
46616
46617
46618
46619
46620
46621
46622
46623
46624
46625
46626
46627
46628
46629
46630
46631
46632
46633
46634
46635
46636
@dataclass(kw_only=True)
class GroupEndpointGetListRequest(OCIRequest):
    """Request to search endpoints in the group.
        The response is either GroupEndpointGetListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_size_limit (Optional[int]):

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

    group_id: str = field(metadata={"alias": "groupId"})

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

    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 GroupEndpointGetListRequest. The column headings for the endpointTable are: "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_fast/commands/commands.py 
125648
125649
125650
125651
125652
125653
125654
125655
125656
125657
125658
125659
125660
125661
@dataclass(kw_only=True)
class GroupEndpointGetListResponse(OCIDataResponse):
    """Response to GroupEndpointGetListRequest.
        The column headings for the endpointTable are:
          \"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_fast/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_fast.client import Client
from mercury_ocip_fast.commands import GroupEndpointGetListRequest

client = Client()

command = GroupEndpointGetListRequest(
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    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_fast.client import Client

client = Client()

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