SystemServiceCodeGetListRequest

Bases: OCIRequest

Request to get all service codes that have been defined 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. The response is either SystemServiceCodeGetListResponse or ErrorResponse.

Attributes:

response_size_limit (Optional[int]):

search_criteria_service_code (Optional[List[SearchCriteriaServiceCode]]):

search_criteria_service_code_description (Optional[List[SearchCriteriaServiceCodeDescription]]):

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

@dataclass(kw_only=True)
class SystemServiceCodeGetListRequest(OCIRequest):
    """Request to get all service codes that have been defined 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.
        The response is either SystemServiceCodeGetListResponse or ErrorResponse.

    Attributes:

        response_size_limit (Optional[int]):

        search_criteria_service_code (Optional[List[SearchCriteriaServiceCode]]):

        search_criteria_service_code_description (Optional[List[SearchCriteriaServiceCodeDescription]]):

    """

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

    search_criteria_service_code: Optional[List[SearchCriteriaServiceCode]] = field(
        default=None, metadata={"alias": "searchCriteriaServiceCode"}
    )

    search_criteria_service_code_description: Optional[
        List[SearchCriteriaServiceCodeDescription]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceCodeDescription"})

Responses

Bases: OCIDataResponse

Response to SystemServiceCodeGetListRequest. Contains a table of defined service codes The column headings are: "Service Code", and "Description".

Attributes:

service_code_table (OCITable):

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

@dataclass(kw_only=True)
class SystemServiceCodeGetListResponse(OCIDataResponse):
    """Response to SystemServiceCodeGetListRequest.
        Contains a table of defined service codes
        The column headings are: \"Service Code\", and \"Description\".

    Attributes:

        service_code_table (OCITable):

    """

    service_code_table: OCITable = field(metadata={"alias": "serviceCodeTable"})

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 SystemServiceCodeGetListRequest

client = Client()

command = SystemServiceCodeGetListRequest(
    response_size_limit=...,
    search_criteria_service_code=...,
    search_criteria_service_code_description=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemServiceCodeGetListRequest",
    response_size_limit=...,
    search_criteria_service_code=...,
    search_criteria_service_code_description=...,
)

print(response)