Skip to content

GroupGetRequest22V5

Bases: OCIRequest

Get the profile for a group. The response is either a GroupGetResponse22V5 or an ErrorResponse.

The following elements are only used in AS data mode and ignored in XS data mode:
  groupExternalId

Attributes:

service_provider_id (Optional[str]):

group_id (Optional[str]):

group_external_id (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupGetRequest22V5(OCIRequest):
    """Get the profile for a group.
        The response is either a GroupGetResponse22V5 or an ErrorResponse.

        The following elements are only used in AS data mode and ignored in XS data mode:
          groupExternalId

    Attributes:

        service_provider_id (Optional[str]):

        group_id (Optional[str]):

        group_external_id (Optional[str]):

    """

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

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

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

Responses

Bases: OCIDataResponse

Response to the GroupGetRequest22V5. The response contains the group's profile information. The following elements are not returned in AS and XS data mode: servicePolicy, callProcessingSliceId, provisioningSliceId, subscriberPartition, preferredDataCenter.

The following elements are only used in XS data mode and not
returned in AS data mode:
preferredDataCenter.

The following data elements are only used in AS data mode and not returned
in XS data mode:
resellerId,
groupExternalId.

The following elements are only used in XS data mode and not returned
in AS data mode:
defaultUserCallingLineIdPhoneNumber.

Attributes:

default_domain (str):

user_limit (int):

user_count (int):

group_name (Optional[str]):

calling_line_id_name (Optional[str]):

calling_line_id_phone_number (Optional[str]):

calling_line_id_display_phone_number (Optional[str]):

time_zone (str):

time_zone_display_name (str):

location_dialing_code (Optional[str]):

contact (Optional[Contact]):

address (Optional[StreetAddress]):

service_policy (Optional[str]):

call_processing_slice_id (Optional[str]):

provisioning_slice_id (Optional[str]):

subscriber_partition (Optional[str]):

preferred_data_center (Optional[str]):

reseller_id (Optional[str]):

default_user_calling_line_id_phone_number (Optional[str]):

service_provider_id (str):

group_id (str):

group_external_id (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class GroupGetResponse22V5(OCIDataResponse):
    """Response to the GroupGetRequest22V5.
        The response contains the group's profile information.
        The following elements are not returned in AS and XS data mode:
        servicePolicy,
        callProcessingSliceId,
        provisioningSliceId,
        subscriberPartition,
        preferredDataCenter.

        The following elements are only used in XS data mode and not
        returned in AS data mode:
        preferredDataCenter.

        The following data elements are only used in AS data mode and not returned
        in XS data mode:
        resellerId,
        groupExternalId.

        The following elements are only used in XS data mode and not returned
        in AS data mode:
        defaultUserCallingLineIdPhoneNumber.

    Attributes:

        default_domain (str):

        user_limit (int):

        user_count (int):

        group_name (Optional[str]):

        calling_line_id_name (Optional[str]):

        calling_line_id_phone_number (Optional[str]):

        calling_line_id_display_phone_number (Optional[str]):

        time_zone (str):

        time_zone_display_name (str):

        location_dialing_code (Optional[str]):

        contact (Optional[Contact]):

        address (Optional[StreetAddress]):

        service_policy (Optional[str]):

        call_processing_slice_id (Optional[str]):

        provisioning_slice_id (Optional[str]):

        subscriber_partition (Optional[str]):

        preferred_data_center (Optional[str]):

        reseller_id (Optional[str]):

        default_user_calling_line_id_phone_number (Optional[str]):

        service_provider_id (str):

        group_id (str):

        group_external_id (Optional[str]):

    """

    default_domain: str = field(metadata={"alias": "defaultDomain"})

    user_limit: int = field(metadata={"alias": "userLimit"})

    user_count: int = field(metadata={"alias": "userCount"})

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

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

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

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

    time_zone: str = field(metadata={"alias": "timeZone"})

    time_zone_display_name: str = field(metadata={"alias": "timeZoneDisplayName"})

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

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

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

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

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

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

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

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

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

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

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

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

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

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 GroupGetRequest22V5

client = Client()

command = GroupGetRequest22V5(
    service_provider_id=...,
    group_id=...,
    group_external_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupGetRequest22V5",
    service_provider_id=...,
    group_id=...,
    group_external_id=...,
)

print(response)