Skip to content

EnterpriseCommonPhoneListGetListRequest

Bases: OCIRequest

Get an enterprise's common phone list. The response is either a EnterpriseCommonPhoneListGetListResponse or an ErrorResponse. The search can be done using multiple criterion. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterion are included in the results. If no search criteria is specified, all results are returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned.

Attributes:

service_provider_id (str):

response_size_limit (Optional[int]):

search_criteria_mode_or (Optional[bool]):

search_criteria_enterprise_common_phone_list_name (Optional[List[SearchCriteriaEnterpriseCommonPhoneListName]]):

search_criteria_enterprise_common_phone_list_number (Optional[List[SearchCriteriaEnterpriseCommonPhoneListNumber]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseCommonPhoneListGetListRequest(OCIRequest):
    """Get an enterprise's common phone list.
        The response is either a EnterpriseCommonPhoneListGetListResponse or an ErrorResponse.
        The search can be done using multiple criterion.
        If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results.
        Otherwise, only results matching all the search criterion are included in the results.
        If no search criteria is specified, all results are returned.
        Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse.
        In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an
        ErrorResponse is returned.

    Attributes:

        service_provider_id (str):

        response_size_limit (Optional[int]):

        search_criteria_mode_or (Optional[bool]):

        search_criteria_enterprise_common_phone_list_name (Optional[List[SearchCriteriaEnterpriseCommonPhoneListName]]):

        search_criteria_enterprise_common_phone_list_number (Optional[List[SearchCriteriaEnterpriseCommonPhoneListNumber]]):

    """

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

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

    search_criteria_mode_or: Optional[bool] = field(
        default=None, metadata={"alias": "searchCriteriaModeOr"}
    )

    search_criteria_enterprise_common_phone_list_name: Optional[
        List[SearchCriteriaEnterpriseCommonPhoneListName]
    ] = field(
        default=None, metadata={"alias": "searchCriteriaEnterpriseCommonPhoneListName"}
    )

    search_criteria_enterprise_common_phone_list_number: Optional[
        List[SearchCriteriaEnterpriseCommonPhoneListNumber]
    ] = field(
        default=None,
        metadata={"alias": "searchCriteriaEnterpriseCommonPhoneListNumber"},
    )

Responses

Bases: OCIDataResponse

Response to the EnterpriseCommonPhoneListGetListRequest. The response contains the enterprise's common phone list.

Attributes:

entry (Optional[List[PhoneListEntry]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class EnterpriseCommonPhoneListGetListResponse(OCIDataResponse):
    """Response to the EnterpriseCommonPhoneListGetListRequest.
        The response contains the enterprise's common phone list.

    Attributes:

        entry (Optional[List[PhoneListEntry]]):

    """

    entry: Optional[List[PhoneListEntry]] = field(
        default=None, metadata={"alias": "entry"}
    )

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

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

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 EnterpriseCommonPhoneListGetListRequest

client = Client()

command = EnterpriseCommonPhoneListGetListRequest(
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_mode_or=...,
    search_criteria_enterprise_common_phone_list_name=...,
    search_criteria_enterprise_common_phone_list_number=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("EnterpriseCommonPhoneListGetListRequest",
    service_provider_id=...,
    response_size_limit=...,
    search_criteria_mode_or=...,
    search_criteria_enterprise_common_phone_list_name=...,
    search_criteria_enterprise_common_phone_list_number=...,
)

print(response)