ServiceProviderGetListRequest

Bases: OCIRequest

Request a list of service providers and/or enterprises in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise within the administrator's reseller meeting the search criteria are returned. The response is either a ServiceProviderGetListResponse or an ErrorResponse.

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

Attributes:

is_enterprise (Optional[bool]):

response_size_limit (Optional[int]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_service_provider_name (Optional[List[SearchCriteriaServiceProviderName]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

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

@dataclass(kw_only=True)
class ServiceProviderGetListRequest(OCIRequest):
    """Request a list of service providers and/or enterprises in the system.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise
        within the administrator's reseller meeting the search criteria are returned.
        The response is either a ServiceProviderGetListResponse or an ErrorResponse.

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

    Attributes:

        is_enterprise (Optional[bool]):

        response_size_limit (Optional[int]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_service_provider_name (Optional[List[SearchCriteriaServiceProviderName]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

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

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

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

Responses

Bases: OCIDataResponse

Response to ServiceProviderGetListRequest. Contains a 3 column table with column headings "Service Provider Id", "Service Provider Name", "Is Enterprise" and "Reseller Id" and a row for each service provider or enterprise.

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

Attributes:

service_provider_table (OCITable):

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

@dataclass(kw_only=True)
class ServiceProviderGetListResponse(OCIDataResponse):
    """Response to ServiceProviderGetListRequest.
        Contains a 3 column table with column headings \"Service Provider Id\", \"Service Provider Name\",
        \"Is Enterprise\" and \"Reseller Id\" and a row for each service provider or enterprise.

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

    Attributes:

        service_provider_table (OCITable):

    """

    service_provider_table: OCITable = field(metadata={"alias": "serviceProviderTable"})

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 ServiceProviderGetListRequest

client = Client()

command = ServiceProviderGetListRequest(
    is_enterprise=...,
    response_size_limit=...,
    search_criteria_service_provider_id=...,
    search_criteria_service_provider_name=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderGetListRequest",
    is_enterprise=...,
    response_size_limit=...,
    search_criteria_service_provider_id=...,
    search_criteria_service_provider_name=...,
    search_criteria_reseller_id=...,
)

print(response)