SystemPreferredCarrierGetGroupListRequest

Bases: OCIRequest

Requests a list of groups using the specified carrier. It is possible to restrict the number of rows returned by specifying various search criteria. Multiple search criteria are logically ANDed together. The response is either a SystemPreferredCarrierGetGroupListResponse or an ErrorResponse.

Attributes:

carrier (str):

response_size_limit (Optional[int]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):

search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

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

@dataclass(kw_only=True)
class SystemPreferredCarrierGetGroupListRequest(OCIRequest):
    """Requests a list of groups using the specified carrier.  It is possible to restrict the
        number of rows returned by specifying various search criteria. Multiple search criteria
        are logically ANDed together.
        The response is either a SystemPreferredCarrierGetGroupListResponse or an ErrorResponse.

    Attributes:

        carrier (str):

        response_size_limit (Optional[int]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_group_name (Optional[List[SearchCriteriaGroupName]]):

        search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

    """

    carrier: str = field(metadata={"alias": "carrier"})

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

    search_criteria_exact_service_provider: Optional[
        SearchCriteriaExactServiceProvider
    ] = field(default=None, metadata={"alias": "searchCriteriaExactServiceProvider"})

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

Responses

Bases: OCIDataResponse

Response to a SystemPreferredCarrierGetGroupListRequest. Contains a table with one row per group. The table columns are: "Group Id", "Group Name", "Organization Id", "Organization Type". The "Organization Id" column is populated with either a service provider Id or an enterprise Id. The "Organization Type" column is populated with one of the enumerated strings defined in the OrganizationType OCI data type. Please see OCISchemaDataTypes.xsd for details on OrganizationType.

Attributes:

groups_using_carrier_table (OCITable):

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

@dataclass(kw_only=True)
class SystemPreferredCarrierGetGroupListResponse(OCIDataResponse):
    """Response to a SystemPreferredCarrierGetGroupListRequest.
        Contains a table with one row per group.
        The table columns are: \"Group Id\", \"Group Name\", \"Organization Id\", \"Organization Type\".
        The \"Organization Id\" column is populated with either a service provider Id or an enterprise Id.
        The \"Organization Type\" column is populated with one of the enumerated strings defined in the
        OrganizationType OCI data type.  Please see OCISchemaDataTypes.xsd for details on OrganizationType.

    Attributes:

        groups_using_carrier_table (OCITable):

    """

    groups_using_carrier_table: OCITable = field(
        metadata={"alias": "groupsUsingCarrierTable"}
    )

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 SystemPreferredCarrierGetGroupListRequest

client = Client()

command = SystemPreferredCarrierGetGroupListRequest(
    carrier=...,
    response_size_limit=...,
    search_criteria_group_id=...,
    search_criteria_group_name=...,
    search_criteria_exact_service_provider=...,
    search_criteria_service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemPreferredCarrierGetGroupListRequest",
    carrier=...,
    response_size_limit=...,
    search_criteria_group_id=...,
    search_criteria_group_name=...,
    search_criteria_exact_service_provider=...,
    search_criteria_service_provider_id=...,
)

print(response)