Skip to content

ServiceProviderGetRequest22V4

Bases: OCIRequest

Get the profile for a service provider or enterprise. The response is either a ServiceProviderGetResponse22V4 or an ErrorResponse.

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

Attributes:

service_provider_id (Optional[str]):

service_provider_external_id (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderGetRequest22V4(OCIRequest):
    """Get the profile for a service provider or enterprise.
        The response is either a ServiceProviderGetResponse22V4 or an ErrorResponse.

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

    Attributes:

        service_provider_id (Optional[str]):

        service_provider_external_id (Optional[str]):

    """

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

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

Responses

Bases: OCIDataResponse

Response to the ServiceProviderGetRequest22V4. The response contains the service provider or enterprise's profile information. The following elements are not returned in AS and XS data mode: servicePolicy, callProcessingSliceId, subscriberPartition.

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

Attributes:

is_enterprise (Optional[bool]):

use_custom_routing_profile (Optional[bool]):

default_domain (str):

service_provider_name (Optional[str]):

support_email (Optional[str]):

contact (Optional[Contact]):

address (Optional[StreetAddress]):

use_service_provider_languages (bool):

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]):

service_provider_id (str):

service_provider_external_id (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderGetResponse22V4(OCIDataResponse):
    """Response to the ServiceProviderGetRequest22V4.
        The response contains the service provider or enterprise's profile information.
        The following elements are not returned in AS and XS data mode:
        servicePolicy,
        callProcessingSliceId,
        subscriberPartition.

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

    Attributes:

        is_enterprise (Optional[bool]):

        use_custom_routing_profile (Optional[bool]):

        default_domain (str):

        service_provider_name (Optional[str]):

        support_email (Optional[str]):

        contact (Optional[Contact]):

        address (Optional[StreetAddress]):

        use_service_provider_languages (bool):

        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]):

        service_provider_id (str):

        service_provider_external_id (Optional[str]):

    """

    is_enterprise: Optional[bool] = field(
        default=None, metadata={"alias": "isEnterprise"}
    )

    use_custom_routing_profile: Optional[bool] = field(
        default=None, metadata={"alias": "useCustomRoutingProfile"}
    )

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

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

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

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

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

    use_service_provider_languages: bool = field(
        metadata={"alias": "useServiceProviderLanguages"}
    )

    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"})

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

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

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 ServiceProviderGetRequest22V4

client = Client()

command = ServiceProviderGetRequest22V4(
    service_provider_id=...,
    service_provider_external_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderGetRequest22V4",
    service_provider_id=...,
    service_provider_external_id=...,
)

print(response)