SystemPreferredCarrierGetUserListRequest

Bases: OCIRequest

Requests a list of users using the specified carrier. It is possible to restrict the number of rows returned by specifying various search criteria. Multiple search criteria are logically ANDed together. The response is either a SystemPreferreredCarrierGetUserListResponse or an ErrorResponse.

Attributes:

carrier (str):

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_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

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

@dataclass(kw_only=True)
class SystemPreferredCarrierGetUserListRequest(OCIRequest):
    """Requests a list of users using the specified carrier.  It is possible to restrict the
        number of rows returned by specifying various search criteria. Multiple search criteria
        are logically ANDed together.
        The response is either a SystemPreferreredCarrierGetUserListResponse
        or an ErrorResponse.

    Attributes:

        carrier (str):

        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_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

    """

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

    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_user_id: Optional[List[SearchCriteriaUserId]] = field(
        default=None, metadata={"alias": "searchCriteriaUserId"}
    )

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

Responses

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 SystemPreferredCarrierGetUserListRequest

client = Client()

command = SystemPreferredCarrierGetUserListRequest(
    carrier=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_email_address=...,
    search_criteria_user_id=...,
    search_criteria_extension=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemPreferredCarrierGetUserListRequest",
    carrier=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_dn=...,
    search_criteria_email_address=...,
    search_criteria_user_id=...,
    search_criteria_extension=...,
)

print(response)