GroupDnGetAssignmentPagedSortedListRequest
Bases: OCIRequest
Get the list of assigned and unassigned DNs in a group. Each DN can be assigned to a user and/or department. Ranges of DNs with identical assignment and activation properties are coalesced to a single table row entry. Dns assigned to the IMRN pool are not listed in the response. 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. If no sortOrder is included the response is sorted by Phone Number by default. Multiple search criteria are logically ANDed together unless the searchCriteriaModeOr option is included. Then the search criterion are logically ORed together.
The department in both the search criteria and sort by fields refer to the department to which
the dn belongs.
A limitation to the search by DN activation exists when the Number Activation mode is set to
Off. In this case DNs not assigned to users are never returned by queries with the
"dnActivationSearchCriteria" included.
The response is either a GroupDnGetAssignmentPagedSortedListResponse or an ErrorResponse.
Attributes:
service_provider_id (str):
group_id (str):
response_paging_control (Optional[ResponsePagingControl]):
sort_order (Optional[List[SortOrderGroupDnGetAssignmentPagedSortedList]]):
search_criteria_dn (Optional[List[SearchCriteriaDn]]):
search_criteria_department_name (Optional[List[SearchCriteriaDepartmentName]]):
search_criteria_exact_dn_activation (Optional[SearchCriteriaExactDnActivation]):
search_criteria_exact_dn_availability (Optional[SearchCriteriaExactDnAvailability]):
search_criteria_user_id (Optional[List[SearchCriteriaUserId]]):
search_criteria_user_first_name (Optional[List[SearchCriteriaUserFirstName]]):
search_criteria_user_last_name (Optional[List[SearchCriteriaUserLastName]]):
search_criteria_exact_user_type (Optional[List[SearchCriteriaExactUserType]]):
search_criteria_extension (Optional[List[SearchCriteriaExtension]]):
search_criteria_email_address (Optional[List[SearchCriteriaEmailAddress]]):
search_criteria_mode_or (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
45877 45878 45879 45880 45881 45882 45883 45884 45885 45886 45887 45888 45889 45890 45891 45892 45893 45894 45895 45896 45897 45898 45899 45900 45901 45902 45903 45904 45905 45906 45907 45908 45909 45910 45911 45912 45913 45914 45915 45916 45917 45918 45919 45920 45921 45922 45923 45924 45925 45926 45927 45928 45929 45930 45931 45932 45933 45934 45935 45936 45937 45938 45939 45940 45941 45942 45943 45944 45945 45946 45947 45948 45949 45950 45951 45952 45953 45954 45955 45956 45957 45958 45959 45960 45961 45962 45963 45964 45965 45966 45967 45968 45969 45970 45971 45972 45973 45974 45975 45976 45977 45978 45979 45980 45981 45982 45983 45984 45985 45986 | |
Responses
Bases: OCIDataResponse
Response to the GroupDnGetAssignmentPagedSortedListRequest.
The response contains a table with columns: "Phone Numbers", "Department", "Department Type",
"Parent Department", "Parent Department Type", "Activated", "Available", "User Id",
"Last Name", "First Name", "Extension", "Email Address", "User Type", "Country Code", "National Prefix".
The "Phone Numbers" column contains either a single DN or a range of DNs.
The "User Id", "Last Name" and "First Name" columns contains the corresponding attributes of the user possessing the DN(s).
For a service instance, "Last Name" contains the service instance name and "First Name" column contains the corresponding enumerated UserType value.
The "Department" column contains the department of the DN, not the department of the user or service instance.
The "Department Type" and "Parent Department Type" columns will contain the values "Enterprise" or "Group".
The "Activated" column indicates if the DN or DN range has been activated. Only has a value if the DN(s) is assigned to a user.
The "User Type" column contains the corresponding enumerated UserType value.
The "Country Code" column indicates the dialing prefix for the phone number.
The "National Prefix" column indicates the digit sequence to be dialed before the telephone number.
NOTE: the same phone number can show up in the list twice if the phone number is being used as the group calling line Id.
Attributes:
dn_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
Example Usage
from mercury_ocip.client import Client
from mercury_ocip.commands import GroupDnGetAssignmentPagedSortedListRequest
client = Client()
command = GroupDnGetAssignmentPagedSortedListRequest(
service_provider_id=...,
group_id=...,
response_paging_control=...,
sort_order=...,
search_criteria_dn=...,
search_criteria_department_name=...,
search_criteria_exact_dn_activation=...,
search_criteria_exact_dn_availability=...,
search_criteria_user_id=...,
search_criteria_user_first_name=...,
search_criteria_user_last_name=...,
search_criteria_exact_user_type=...,
search_criteria_extension=...,
search_criteria_email_address=...,
search_criteria_mode_or=...,
)
response = client.command(command)
print(response)
Example 2 with Raw Command
from mercury_ocip.client import Client
client = Client()
response = client.raw_command("GroupDnGetAssignmentPagedSortedListRequest",
service_provider_id=...,
group_id=...,
response_paging_control=...,
sort_order=...,
search_criteria_dn=...,
search_criteria_department_name=...,
search_criteria_exact_dn_activation=...,
search_criteria_exact_dn_availability=...,
search_criteria_user_id=...,
search_criteria_user_first_name=...,
search_criteria_user_last_name=...,
search_criteria_exact_user_type=...,
search_criteria_extension=...,
search_criteria_email_address=...,
search_criteria_mode_or=...,
)
print(response)