Skip to content

ServiceProviderGetPagedSortedListRequest

Bases: OCIRequest

Request a list of service providers and/or enterprises in the system. The response is either a ServiceProviderGetPagedSortedListResponse or an ErrorResponse. If reseller administrator sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise within the administrator's reseller meeting the search criteria are returned. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum responsePageSize by default. If no sortOrder is included, the response is sorted by Service Provider Id ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.

Attributes:

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderServiceProviderGetPagedSortedList]]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_service_provider_name (Optional[List[SearchCriteriaServiceProviderName]]):

search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderGetPagedSortedListRequest(OCIRequest):
    """Request a list of service providers and/or enterprises in the system.
        The response is either a ServiceProviderGetPagedSortedListResponse or an ErrorResponse.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise
        within the administrator's reseller meeting the search criteria are returned.
        If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by
        default, and the responsePageSize will be set to the maximum responsePageSize by default.
        If no sortOrder is included, the response is sorted by Service Provider Id ascending by default.
        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is
        included. Then the search criteria are logically ORed together.

    Attributes:

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderServiceProviderGetPagedSortedList]]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_service_provider_name (Optional[List[SearchCriteriaServiceProviderName]]):

        search_criteria_exact_organization_type (Optional[SearchCriteriaExactOrganizationType]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

        search_criteria_mode_or (Optional[bool]):

    """

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_order: Optional[List[SortOrderServiceProviderGetPagedSortedList]] = field(
        default=None, metadata={"alias": "sortOrder"}
    )

    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_exact_organization_type: Optional[
        SearchCriteriaExactOrganizationType
    ] = field(default=None, metadata={"alias": "searchCriteriaExactOrganizationType"})

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

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

Responses

Bases: OCIDataResponse

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

The following columns are only populated in AS data mode:
  "Reseller Id",
  "Service Provider External Id

Attributes:

service_provider_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderGetPagedSortedListResponse(OCIDataResponse):
    """Response to ServiceProviderGetPagedSortedListRequest.
        Contains a table with column headings \"Service Provider Id\", \"Service Provider Name\"
        and \"Is Enterprise\", \"Reseller Id\" and \"Service Provider External Id\" and a row for each service provider or enterprise.

        The following columns are only populated in AS data mode:
          \"Reseller Id\",
          \"Service Provider External 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 ServiceProviderGetPagedSortedListRequest

client = Client()

command = ServiceProviderGetPagedSortedListRequest(
    response_paging_control=...,
    sort_order=...,
    search_criteria_service_provider_id=...,
    search_criteria_service_provider_name=...,
    search_criteria_exact_organization_type=...,
    search_criteria_reseller_id=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderGetPagedSortedListRequest",
    response_paging_control=...,
    sort_order=...,
    search_criteria_service_provider_id=...,
    search_criteria_service_provider_name=...,
    search_criteria_exact_organization_type=...,
    search_criteria_reseller_id=...,
    search_criteria_mode_or=...,
)

print(response)