Skip to content

GroupAdminGetPagedSortedListRequest

Bases: OCIRequest

Get a list of group and department administrators within the group. The response is either a GroupAdminGetPagedSortedListResponse or an ErrorResponse. If no sort criterion is included, the response is sorted by administrator id ascending by default. 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. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criteria are logically ORed together.

Attributes:

service_provider_id (str):

group_id (str):

response_paging_control (Optional[ResponsePagingControl]):

sort_order (Optional[List[SortOrderGroupAdminGetPagedSortedList]]):

search_criteria_admin_id (Optional[List[SearchCriteriaAdminId]]):

search_criteria_admin_last_name (Optional[List[SearchCriteriaAdminLastName]]):

search_criteria_admin_first_name (Optional[List[SearchCriteriaAdminFirstName]]):

search_criteria_exact_group_admin_type (Optional[List[SearchCriteriaExactGroupAdminType]]):

search_criteria_language (Optional[List[SearchCriteriaLanguage]]):

search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAdminGetPagedSortedListRequest(OCIRequest):
    """Get a list of group and department administrators within the group.
        The response is either a GroupAdminGetPagedSortedListResponse or an ErrorResponse.
        If no sort criterion is included, the response is sorted by administrator id ascending by default.
        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.
        Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is
        included. Then the search criteria are logically ORed together.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_paging_control (Optional[ResponsePagingControl]):

        sort_order (Optional[List[SortOrderGroupAdminGetPagedSortedList]]):

        search_criteria_admin_id (Optional[List[SearchCriteriaAdminId]]):

        search_criteria_admin_last_name (Optional[List[SearchCriteriaAdminLastName]]):

        search_criteria_admin_first_name (Optional[List[SearchCriteriaAdminFirstName]]):

        search_criteria_exact_group_admin_type (Optional[List[SearchCriteriaExactGroupAdminType]]):

        search_criteria_language (Optional[List[SearchCriteriaLanguage]]):

        search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):

        search_criteria_mode_or (Optional[bool]):

    """

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

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

    response_paging_control: Optional[ResponsePagingControl] = field(
        default=None, metadata={"alias": "responsePagingControl"}
    )

    sort_order: Optional[List[SortOrderGroupAdminGetPagedSortedList]] = field(
        default=None, metadata={"alias": "sortOrder"}
    )

    search_criteria_admin_id: Optional[List[SearchCriteriaAdminId]] = field(
        default=None, metadata={"alias": "searchCriteriaAdminId"}
    )

    search_criteria_admin_last_name: Optional[List[SearchCriteriaAdminLastName]] = (
        field(default=None, metadata={"alias": "searchCriteriaAdminLastName"})
    )

    search_criteria_admin_first_name: Optional[List[SearchCriteriaAdminFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaAdminFirstName"})
    )

    search_criteria_exact_group_admin_type: Optional[
        List[SearchCriteriaExactGroupAdminType]
    ] = field(default=None, metadata={"alias": "searchCriteriaExactGroupAdminType"})

    search_criteria_language: Optional[List[SearchCriteriaLanguage]] = field(
        default=None, metadata={"alias": "searchCriteriaLanguage"}
    )

    search_criteria_department_name: Optional[List[SearchCriteriaDepartmentName]] = (
        field(default=None, metadata={"alias": "searchCriteriaDepartmentName"})
    )

    search_criteria_mode_or: Optional[bool] = field(
        default=None, metadata={"alias": "searchCriteriaModeOr"}
    )

Responses

Bases: OCIDataResponse

Response to GroupAdminGetPagedSortedListRequest. Contains a 8 column table with column headings "Administrator ID", "Last Name", "First Name", "Administrator Type", "Department", "Language", "Locale" and "Encoding". The following columns are only returned in AS data mode: "Locale" and "Encoding".

Attributes:

group_admin_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupAdminGetPagedSortedListResponse(OCIDataResponse):
    """Response to GroupAdminGetPagedSortedListRequest.
        Contains a 8 column table with column headings \"Administrator ID\",
        \"Last Name\", \"First Name\", \"Administrator Type\", \"Department\",
        \"Language\", \"Locale\" and \"Encoding\".
        The following columns are only returned in AS data mode:
        \"Locale\" and \"Encoding\".

    Attributes:

        group_admin_table (OCITable):

    """

    group_admin_table: OCITable = field(metadata={"alias": "groupAdminTable"})

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 GroupAdminGetPagedSortedListRequest

client = Client()

command = GroupAdminGetPagedSortedListRequest(
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_admin_id=...,
    search_criteria_admin_last_name=...,
    search_criteria_admin_first_name=...,
    search_criteria_exact_group_admin_type=...,
    search_criteria_language=...,
    search_criteria_department_name=...,
    search_criteria_mode_or=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAdminGetPagedSortedListRequest",
    service_provider_id=...,
    group_id=...,
    response_paging_control=...,
    sort_order=...,
    search_criteria_admin_id=...,
    search_criteria_admin_last_name=...,
    search_criteria_admin_first_name=...,
    search_criteria_exact_group_admin_type=...,
    search_criteria_language=...,
    search_criteria_department_name=...,
    search_criteria_mode_or=...,
)

print(response)