SystemBroadWorksMobilityGeographicalPoolGetListRequest

Bases: OCIRequest

Get a list of geographical pools defined in the system. If countryCode is set, return the IMRN pools associated with the country code. The response is either SystemBroadWorksMobilityGeographicalPoolGetListResponse or ErrorResponse.

Attributes:

country_code (Optional[str]):

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

@dataclass(kw_only=True)
class SystemBroadWorksMobilityGeographicalPoolGetListRequest(OCIRequest):
    """Get a list of geographical pools defined in the system. If countryCode is set, return the IMRN pools associated with the country code.
        The response is either SystemBroadWorksMobilityGeographicalPoolGetListResponse or ErrorResponse.

    Attributes:

        country_code (Optional[str]):

    """

    country_code: Optional[str] = field(default=None, metadata={"alias": "countryCode"})

Responses

Bases: OCIDataResponse

Response to the SystemBroadWorksMobilityGeographicalPoolGetListRequest. Contains a table with column headings: "Pool", "Country Code", "Is Default", "Description".

Attributes:

geographical_pool_table (OCITable):

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

@dataclass(kw_only=True)
class SystemBroadWorksMobilityGeographicalPoolGetListResponse(OCIDataResponse):
    """Response to the SystemBroadWorksMobilityGeographicalPoolGetListRequest.
        Contains a table with column headings: \"Pool\", \"Country Code\", \"Is Default\", \"Description\".

    Attributes:

        geographical_pool_table (OCITable):

    """

    geographical_pool_table: OCITable = field(
        metadata={"alias": "geographicalPoolTable"}
    )

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 SystemBroadWorksMobilityGeographicalPoolGetListRequest

client = Client()

command = SystemBroadWorksMobilityGeographicalPoolGetListRequest(
    country_code=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemBroadWorksMobilityGeographicalPoolGetListRequest",
    country_code=...,
)

print(response)