Skip to content

UserGetListInSystemRequest

Bases: OCIRequest

Request the list of users in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the users in the administrator's reseller meeting the search criteria are returned.

The response is either a UserGetListInSystemResponse or an ErrorResponse.

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

Attributes:

response_size_limit (Optional[int]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):

search_criteria_exact_user_network_class_of_service (Optional[SearchCriteriaExactUserNetworkClassOfService]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_user_external_id (Optional[List[SearchCriteriaUserExternalId]]):

search_criteria_exact_user_person_id (Optional[SearchCriteriaExactUserPersonId]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserGetListInSystemRequest(OCIRequest):
    """Request the list of users in the system.
        It is possible to search by various criteria to restrict the number of rows returned.
        Multiple search criteria are logically ANDed together.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the users
        in the administrator's reseller meeting the search criteria are returned.

        The response is either a UserGetListInSystemResponse or an ErrorResponse.

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

    Attributes:

        response_size_limit (Optional[int]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):

        search_criteria_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_exact_service_provider (Optional[SearchCriteriaExactServiceProvider]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_exact_user_in_trunk_group (Optional[SearchCriteriaExactUserInTrunkGroup]):

        search_criteria_exact_user_network_class_of_service (Optional[SearchCriteriaExactUserNetworkClassOfService]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_user_external_id (Optional[List[SearchCriteriaUserExternalId]]):

        search_criteria_exact_user_person_id (Optional[SearchCriteriaExactUserPersonId]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_user_last_name: Optional[List[SearchCriteriaUserLastName]] = field(
        default=None, metadata={"alias": "searchCriteriaUserLastName"}
    )

    search_criteria_user_first_name: Optional[List[SearchCriteriaUserFirstName]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserFirstName"})
    )

    search_criteria_dn: Optional[List[SearchCriteriaDn]] = field(
        default=None, metadata={"alias": "searchCriteriaDn"}
    )

    search_criteria_email_address: Optional[List[SearchCriteriaEmailAddress]] = field(
        default=None, metadata={"alias": "searchCriteriaEmailAddress"}
    )

    search_criteria_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

    search_criteria_exact_service_provider: Optional[
        SearchCriteriaExactServiceProvider
    ] = field(default=None, metadata={"alias": "searchCriteriaExactServiceProvider"})

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

    search_criteria_exact_user_in_trunk_group: Optional[
        SearchCriteriaExactUserInTrunkGroup
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserInTrunkGroup"})

    search_criteria_exact_user_network_class_of_service: Optional[
        SearchCriteriaExactUserNetworkClassOfService
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactUserNetworkClassOfService"}
    )

    search_criteria_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

    search_criteria_user_external_id: Optional[List[SearchCriteriaUserExternalId]] = (
        field(default=None, metadata={"alias": "searchCriteriaUserExternalId"})
    )

    search_criteria_exact_user_person_id: Optional[SearchCriteriaExactUserPersonId] = (
        field(default=None, metadata={"alias": "searchCriteriaExactUserPersonId"})
    )

    search_criteria_extension: Optional[List[SearchCriteriaExtension]] = field(
        default=None, metadata={"alias": "searchCriteriaExtension"}
    )

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

Responses

Bases: OCIDataResponse

Response to UserGetListInSystemRequest. Contains a table with column headings : "User Id", "Group Id", "Service Provider Id", "Last Name", "First Name", "Department", "Phone Number", "Phone Number Activated", "Email Address", "Hiragana Last Name", "Hiragana First Name", "In Trunk Group", "Extension", "Reseller Id", "User External Id" in a row for each user.

The following columns are only returned in AS data mode:
  "Reseller Id"
  "User External Id"

Attributes:

user_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class UserGetListInSystemResponse(OCIDataResponse):
    """Response to UserGetListInSystemRequest.
        Contains a table with column headings : \"User Id\", \"Group Id\", \"Service Provider Id\", \"Last Name\", \"First Name\",
        \"Department\", \"Phone Number\", \"Phone Number Activated\", \"Email Address\",  \"Hiragana Last Name\", \"Hiragana First Name\", \"In Trunk Group\", \"Extension\", \"Reseller Id\", \"User External Id\"
        in a row for each user.

        The following columns are only returned in AS data mode:
          \"Reseller Id\"
          \"User External Id\"

    Attributes:

        user_table (OCITable):

    """

    user_table: OCITable = field(metadata={"alias": "userTable"})

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 UserGetListInSystemRequest

client = Client()

command = UserGetListInSystemRequest(
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_email_address=...,
    search_criteria_group_id=...,
    search_criteria_exact_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_user_in_trunk_group=...,
    search_criteria_exact_user_network_class_of_service=...,
    search_criteria_user_id=...,
    search_criteria_user_external_id=...,
    search_criteria_exact_user_person_id=...,
    search_criteria_extension=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserGetListInSystemRequest",
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_email_address=...,
    search_criteria_group_id=...,
    search_criteria_exact_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_exact_user_in_trunk_group=...,
    search_criteria_exact_user_network_class_of_service=...,
    search_criteria_user_id=...,
    search_criteria_user_external_id=...,
    search_criteria_exact_user_person_id=...,
    search_criteria_extension=...,
    search_criteria_reseller_id=...,
)

print(response)