UserAnnouncementFileGetAvailableListRequest

Bases: OCIRequest

Get the list of available announcement files for a User from the Announcement Repository, for Virtual subscribers the list will also include the announcements for it's group.

Attributes:

user_id (str):

announcement_file_type (Optional[str]):

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

@dataclass(kw_only=True)
class UserAnnouncementFileGetAvailableListRequest(OCIRequest):
    """Get the list of available announcement files for a User from the Announcement Repository,
        for Virtual subscribers the list will also include the announcements for it's group.

    Attributes:

        user_id (str):

        announcement_file_type (Optional[str]):

    """

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

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

Responses

:: mercury_ocip.commands.base_command.ErrorResponse

:: mercury_ocip.commands.base_command.SuccessResponse

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import UserAnnouncementFileGetAvailableListRequest

client = Client()

command = UserAnnouncementFileGetAvailableListRequest(
    user_id=...,
    announcement_file_type=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserAnnouncementFileGetAvailableListRequest",
    user_id=...,
    announcement_file_type=...,
)

print(response)