GroupAnnouncementFileGetPagedSortedListRequest
Bases: OCIRequest
Get the list of available announcement files for a Group. If the responsePagingControl element is not provided, the paging startIndex will be set to 1 by default, and the responsePageSize will be set to the maximum responsePageSize by default. If no sortOrder is included, the response is sorted by Name ascending by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.
The following elements are only used in AS data mode and ignored in XS data mode:
groupExternalId
The response is either a GroupAnnouncementFileGetPagedSortedListResponse or an ErrorResponse.
Attributes:
service_provider_id (Optional[str]):
group_id (Optional[str]):
group_external_id (Optional[str]):
response_paging_control (Optional[ResponsePagingControl]):
sort_by_announcement_file_name (Optional[SortByAnnouncementFileName]):
sort_by_announcement_file_size (Optional[SortByAnnouncementFileSize]):
search_criteria_announcement_file_name (Optional[List[SearchCriteriaAnnouncementFileName]]):
search_criteria_exact_announcement_file_type (Optional[SearchCriteriaExactAnnouncementFileType]):
search_criteria_exact_media_file_type (Optional[List[SearchCriteriaExactMediaFileType]]):
search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
33146 33147 33148 33149 33150 33151 33152 33153 33154 33155 33156 33157 33158 33159 33160 33161 33162 33163 33164 33165 33166 33167 33168 33169 33170 33171 33172 33173 33174 33175 33176 33177 33178 33179 33180 33181 33182 33183 33184 33185 33186 33187 33188 33189 33190 33191 33192 33193 33194 33195 33196 33197 33198 33199 33200 33201 33202 33203 33204 33205 33206 33207 33208 33209 33210 33211 33212 33213 33214 33215 33216 33217 33218 33219 33220 33221 33222 33223 33224 33225 | |
Responses
Bases: OCIDataResponse
Response to GroupAnnouncementFileGetPagedSortedListRequest. The response contains a table with columns: "Name", "Media Type", "File Size", and "Announcement File External Id". The "Name" column contains the name of the announcement file. The "Media Type" column contains the media type of the announcement File with the possible values: WMA - Windows Media Audio file WAV - A WAV file 3GP - A 3GP file MOV - A MOV file using a H.263 or H.264 codec. The "File Size" column contains the file size (KB) of the announcement file.
The following columns are populated in AS data mode only:
"Announcement File External Id"
Attributes:
announcement_table (Optional[OCITable]):
Source code in src/mercury_ocip/commands/commands.py
Example Usage
from mercury_ocip.client import Client
from mercury_ocip.commands import GroupAnnouncementFileGetPagedSortedListRequest
client = Client()
command = GroupAnnouncementFileGetPagedSortedListRequest(
service_provider_id=...,
group_id=...,
group_external_id=...,
response_paging_control=...,
sort_by_announcement_file_name=...,
sort_by_announcement_file_size=...,
search_criteria_announcement_file_name=...,
search_criteria_exact_announcement_file_type=...,
search_criteria_exact_media_file_type=...,
search_criteria_mode_or=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip.client import Client
client = Client()
response = client.raw_command("GroupAnnouncementFileGetPagedSortedListRequest",
service_provider_id=...,
group_id=...,
group_external_id=...,
response_paging_control=...,
sort_by_announcement_file_name=...,
sort_by_announcement_file_size=...,
search_criteria_announcement_file_name=...,
search_criteria_exact_announcement_file_type=...,
search_criteria_exact_media_file_type=...,
search_criteria_mode_or=...,
)
print(response)