Skip to content

GroupAnnouncementFileGetRequest22

Bases: OCIRequest

Request to get the announcement repository file information.

The following elements are only used in AS data mode and ignored in XS data mode:
  announcementFileExternalId

The response is either GroupAnnouncementFileGetResponse22 or ErrorResponse.

Attributes:

service_provider_id (Optional[str]):

group_id (Optional[str]):

announcement_file_key (Optional[AnnouncementFileKey]):

announcement_file_external_id (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAnnouncementFileGetRequest22(OCIRequest):
    """Request to get the announcement repository file information.

        The following elements are only used in AS data mode and ignored in XS data mode:
          announcementFileExternalId

        The response is either GroupAnnouncementFileGetResponse22 or ErrorResponse.

    Attributes:

        service_provider_id (Optional[str]):

        group_id (Optional[str]):

        announcement_file_key (Optional[AnnouncementFileKey]):

        announcement_file_external_id (Optional[str]):

    """

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

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

    announcement_file_key: Optional[AnnouncementFileKey] = field(
        default=None, metadata={"alias": "announcementFileKey"}
    )

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

Responses

Bases: OCIDataResponse

Response to GroupAnnouncementFileGetRequest22. The response contains the file size, uploaded timestamp, description and usage for an announcement file in the user announcement repository. The usage table has columns "Service Name", and "Instance Name". The Service Name values correspond to string values of the GroupService and UserService data types. With the exception of the string "Voice Portal" which is returned when the announcement is being used by Voice Portal Personalized Name.

The following data elements are only used in AS data mode:
  announcementFileExternalId

Attributes:

description (str):

filesize (int):

last_uploaded (str):

service_provider_id (str):

group_id (str):

announcement_file_key (AnnouncementFileKey):

announcement_file_external_id (Optional[str]):

usage_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAnnouncementFileGetResponse22(OCIDataResponse):
    """Response to GroupAnnouncementFileGetRequest22.
        The response contains the file size, uploaded timestamp, description and usage for
        an announcement file in the user announcement repository.
        The usage table has columns \"Service Name\", and \"Instance Name\".
        The Service Name values correspond to string values of the GroupService and UserService data types.
        With the exception of the string \"Voice Portal\" which is returned when the announcement is being used by Voice Portal Personalized Name.

        The following data elements are only used in AS data mode:
          announcementFileExternalId

    Attributes:

        description (str):

        filesize (int):

        last_uploaded (str):

        service_provider_id (str):

        group_id (str):

        announcement_file_key (AnnouncementFileKey):

        announcement_file_external_id (Optional[str]):

        usage_table (OCITable):

    """

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

    filesize: int = field(metadata={"alias": "filesize"})

    last_uploaded: str = field(metadata={"alias": "lastUploaded"})

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    announcement_file_key: AnnouncementFileKey = field(
        metadata={"alias": "announcementFileKey"}
    )

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

    usage_table: OCITable = field(metadata={"alias": "usageTable"})

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 GroupAnnouncementFileGetRequest22

client = Client()

command = GroupAnnouncementFileGetRequest22(
    service_provider_id=...,
    group_id=...,
    announcement_file_key=...,
    announcement_file_external_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAnnouncementFileGetRequest22",
    service_provider_id=...,
    group_id=...,
    announcement_file_key=...,
    announcement_file_external_id=...,
)

print(response)