Skip to content

GroupCustomContactDirectoryGetAvailableUserListRequest17

Bases: OCIRequest

Get a list of users that can be part of a custom contact directory. The response is either GroupCustomContactDirectoryGetAvailableUserListResponse17 or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

response_size_limit (Optional[int]):

search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCustomContactDirectoryGetAvailableUserListRequest17(OCIRequest):
    """Get a list of users that can be part of a custom contact directory.
        The response is either GroupCustomContactDirectoryGetAvailableUserListResponse17 or  ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        response_size_limit (Optional[int]):

        search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):

        search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):

        search_criteria_exact_user_department (Optional[SearchCriteriaExactUserDepartment]):

        search_criteria_exact_user_group (Optional[SearchCriteriaExactUserGroup]):

        search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):

        search_criteria_dn (Optional[List[SearchCriteriaDn]]):

        search_criteria_extension (Optional[List[SearchCriteriaExtension]]):

    """

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

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

    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_exact_user_department: Optional[
        SearchCriteriaExactUserDepartment
    ] = field(default=None, metadata={"alias": "searchCriteriaExactUserDepartment"})

    search_criteria_exact_user_group: Optional[SearchCriteriaExactUserGroup] = field(
        default=None, metadata={"alias": "searchCriteriaExactUserGroup"}
    )

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

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

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

Responses

Bases: OCIDataResponse

Response to the GroupCustomContactDirectoryGetAvailableUserListRequest17. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Virtual On-Net Phone Number", "Group Id", "Is Virtual On-Net User", "Phone Number", "Extension", "Department", "Email Address".

If the entry represents a Virtual On-Net user then "User Id" is blank,
the "Virtual On-Net Phone Number" contains the phone Number of the
Virtual On-Net user, the "Group Id" contains the Virtual On-Net user's
group and the "Is Virtual On-Net User" contains true.

If the entry represents a BroadWorks user then the "User Id" contains
his BroadWorks userId, the "Virtual On-Net Phone Number" and
"Group Id" fields are blank and the "Is Virtual On-Net User"
contains false.

Attributes:

user_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class GroupCustomContactDirectoryGetAvailableUserListResponse17(OCIDataResponse):
    """Response to the
        GroupCustomContactDirectoryGetAvailableUserListRequest17.
        Contains a table with column headings: \"User Id\", \"Last Name\",
        \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
        \"Virtual On-Net Phone Number\", \"Group Id\", \"Is Virtual On-Net User\",
        \"Phone Number\", \"Extension\", \"Department\", \"Email Address\".

        If the entry represents a Virtual On-Net user then \"User Id\" is blank,
        the \"Virtual On-Net Phone Number\" contains the phone Number of the
        Virtual On-Net user, the \"Group Id\" contains the Virtual On-Net user's
        group and the \"Is Virtual On-Net User\" contains true.

        If the entry represents a BroadWorks user then the \"User Id\" contains
        his BroadWorks userId, the \"Virtual On-Net Phone Number\" and
        \"Group Id\" fields are blank and the \"Is Virtual On-Net User\"
        contains false.

    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 GroupCustomContactDirectoryGetAvailableUserListRequest17

client = Client()

command = GroupCustomContactDirectoryGetAvailableUserListRequest17(
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_group=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupCustomContactDirectoryGetAvailableUserListRequest17",
    service_provider_id=...,
    group_id=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_exact_user_group=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
)

print(response)