Skip to content

UserSMDIMessageDeskGetServerListRequest

Bases: OCIRequest

Request to get a list of SMDI Servers defined for a user. The response is either a UserSMDIMessageDeskGetServerListResponse or an ErrorResponse.

Attributes:

user_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserSMDIMessageDeskGetServerListRequest(OCIRequest):
    """Request to get a list of SMDI Servers defined for a user.
        The response is either a UserSMDIMessageDeskGetServerListResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

Responses

Bases: OCIDataResponse

Response to the UserSMDIMessageDeskGetServerListRequest. The SMDI Server table column headings are: "Device Name", "Net Address", "Port".

Attributes:

smdi_server_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserSMDIMessageDeskGetServerListResponse(OCIDataResponse):
    """Response to the UserSMDIMessageDeskGetServerListRequest.
        The SMDI Server table column headings are: \"Device Name\", \"Net Address\", \"Port\".

    Attributes:

        smdi_server_table (OCITable):

    """

    smdi_server_table: OCITable = field(metadata={"alias": "smdiServerTable"})

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 UserSMDIMessageDeskGetServerListRequest

client = Client()

command = UserSMDIMessageDeskGetServerListRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserSMDIMessageDeskGetServerListRequest",
    user_id=...,
)

print(response)