UserGetRequest23V2
Bases: OCIRequest
Request to get the user information. The response is either UserGetResponse23V2 or ErrorResponse.
Attributes:
user_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
Responses
Bases: OCIDataResponse
Response to UserGetRequest23V2. It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user.
The following data elements are only used in AS data mode and not returned in XS data mode:
contact[2]-contact[5]
userId
nameDialingName
alternateUserId
resellerId
serviceProviderExternalId
groupExternalId
userExternalId
userPersonId
isPlace
locationDialingCode
The following data elements are only used in XS data mode:
alternateTrunkIdentityDomain
The following data elements are only used in AS data mode:
userId
resellerId
The following data elements are only used in XS data mode:
alternateTrunkIdentityDomain
allowVideo, value "true" is returned in AS data mode.
The userId returned in this response is the user's primary userId and may not be the userId passed in the request.
The country code (countryCode) included is the user's phone number country code when the user has a phone number assigned, or the
user's Group associated country code when the user does not have a phone number assigned, or the system default country code when the
user's Group does not have an associated country code.
The nationalPrefix in this response is the one associated to the included countryCode.
The callingLineIdPhoneNumber is no longer being formatted for display purpose. The value is returned exactly the same as being stored.
Attributes:
service_provider_id (str):
group_id (str):
user_id (str):
last_name (str):
first_name (str):
calling_line_id_last_name (str):
calling_line_id_first_name (str):
name_dialing_name (Optional[NameDialingName]):
hiragana_last_name (Optional[str]):
hiragana_first_name (Optional[str]):
phone_number (Optional[str]):
extension (Optional[str]):
calling_line_id_phone_number (Optional[str]):
department (Optional[DepartmentKey]):
department_full_path (Optional[str]):
language (str):
time_zone (str):
time_zone_display_name (str):
default_alias (str):
alias (Optional[List[str]]):
access_device_endpoint (Optional[AccessDeviceMultipleIdentityAndContactEndpointRead22V2]):
trunk_addressing (Optional[TrunkAddressingMultipleContactRead22]):
title (Optional[str]):
pager_phone_number (Optional[str]):
mobile_phone_number (Optional[str]):
email_address (Optional[str]):
yahoo_id (Optional[str]):
address_location (Optional[str]):
address (Optional[StreetAddress]):
country_code (str):
national_prefix (Optional[str]):
network_class_of_service (Optional[str]):
office_zone_name (Optional[str]):
primary_zone_name (Optional[str]):
imp_id (Optional[str]):
alternate_user_id (Optional[List[AlternateUserIdEntry]]):
allow_video (bool):
reseller_id (Optional[str]):
service_provider_external_id (Optional[str]):
group_external_id (Optional[str]):
user_external_id (Optional[str]):
user_person_id (Optional[str]):
is_place (Optional[bool]):
location_dialing_code (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
154512 154513 154514 154515 154516 154517 154518 154519 154520 154521 154522 154523 154524 154525 154526 154527 154528 154529 154530 154531 154532 154533 154534 154535 154536 154537 154538 154539 154540 154541 154542 154543 154544 154545 154546 154547 154548 154549 154550 154551 154552 154553 154554 154555 154556 154557 154558 154559 154560 154561 154562 154563 154564 154565 154566 154567 154568 154569 154570 154571 154572 154573 154574 154575 154576 154577 154578 154579 154580 154581 154582 154583 154584 154585 154586 154587 154588 154589 154590 154591 154592 154593 154594 154595 154596 154597 154598 154599 154600 154601 154602 154603 154604 154605 154606 154607 154608 154609 154610 154611 154612 154613 154614 154615 154616 154617 154618 154619 154620 154621 154622 154623 154624 154625 154626 154627 154628 154629 154630 154631 154632 154633 154634 154635 154636 154637 154638 154639 154640 154641 154642 154643 154644 154645 154646 154647 154648 154649 154650 154651 154652 154653 154654 154655 154656 154657 154658 154659 154660 154661 154662 154663 154664 154665 154666 154667 154668 154669 154670 154671 154672 154673 154674 154675 154676 154677 154678 154679 154680 154681 154682 154683 154684 154685 154686 154687 154688 154689 154690 154691 154692 154693 154694 154695 154696 154697 154698 154699 154700 154701 154702 154703 154704 154705 154706 154707 154708 154709 154710 154711 154712 154713 154714 154715 154716 154717 154718 154719 154720 154721 154722 154723 154724 154725 154726 154727 154728 154729 154730 154731 154732 154733 154734 154735 154736 154737 154738 154739 154740 154741 154742 154743 154744 154745 154746 154747 154748 154749 154750 154751 154752 154753 154754 154755 154756 154757 154758 154759 154760 154761 154762 154763 154764 154765 154766 154767 154768 154769 154770 154771 154772 154773 154774 154775 154776 154777 | |
Example Usage
from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserGetRequest23V2
client = Client()
command = UserGetRequest23V2(
user_id=...,
)
response = client.command(command)
print(response)