Skip to content

GroupCallParkGetAvailableUserListRequest

Bases: OCIRequest

Get a list of users that can be assigned to a Call Park group. The available user list for a new Call Park group can be obtained by not setting the name. The response is either GroupCallParkGetAvailableUserListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

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

search_criteria_dn (Optional[List[SearchCriteriaDn]]):

search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
Source code in src/mercury_ocip_fast/commands/commands.py 
40805
40806
40807
40808
40809
40810
40811
40812
40813
40814
40815
40816
40817
40818
40819
40820
40821
40822
40823
40824
40825
40826
40827
40828
40829
40830
40831
40832
40833
40834
40835
40836
40837
40838
40839
40840
40841
40842
40843
40844
40845
40846
40847
40848
40849
40850
40851
40852
40853
40854
40855
40856
40857
40858
40859
40860
40861
40862
40863
40864
40865
40866
40867
40868
@dataclass(kw_only=True)
class GroupCallParkGetAvailableUserListRequest(OCIRequest):
    """Get a list of users that can be assigned to a Call Park group.
        The available user list for a new Call Park group can be obtained
        by not setting the name.
        The response is either GroupCallParkGetAvailableUserListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        name (Optional[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_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"})

    name: Optional[str] = field(default=None, metadata={"alias": "name"})

    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_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 GroupCallParkGetAvailableUserListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".

Attributes:

user_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py 
123808
123809
123810
123811
123812
123813
123814
123815
123816
123817
123818
123819
123820
@dataclass(kw_only=True)
class GroupCallParkGetAvailableUserListResponse(OCIDataResponse):
    """Response to the GroupCallParkGetAvailableUserListRequest.
        Contains a table with column headings: \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\",
        \"Hiragana First Name\", \"Phone Number\", \"Extension\", \"Department\", \"Email Address\".

    Attributes:

        user_table (OCITable):

    """

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

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py 
115
116
117
118
119
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 GroupCallParkGetAvailableUserListRequest

client = Client()

command = GroupCallParkGetAvailableUserListRequest(
    service_provider_id=...,
    group_id=...,
    name=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    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("GroupCallParkGetAvailableUserListRequest",
    service_provider_id=...,
    group_id=...,
    name=...,
    response_size_limit=...,
    search_criteria_user_last_name=...,
    search_criteria_user_first_name=...,
    search_criteria_exact_user_department=...,
    search_criteria_user_id=...,
    search_criteria_dn=...,
    search_criteria_extension=...,
)

print(response)