Skip to content

ServiceProviderIntegratedIMPGetRequest22

Bases: OCIRequest

Get the Integrated IMP service attributes for the service provider. The response is either ServiceProviderIntegratedIMPGetResponse22 or ErrorResponse.

Attributes:

service_provider_id (str):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderIntegratedIMPGetRequest22(OCIRequest):
    """Get the Integrated IMP service attributes for the service provider.
        The response is either ServiceProviderIntegratedIMPGetResponse22 or ErrorResponse.

    Attributes:

        service_provider_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the ServiceProviderIntegratedIMPGetRequest22. The response contains the service provider Integrated IMP service attributes. If the service provider is within a reseller, useSystemServiceDomain means using reseller level service domain setting. And useSystemMessagingServer means using the reseller level messaging server setting. The element useResellerIMPIdSetting means using the reseller level IMP User ID setting.

Attributes:

use_system_service_domain (bool):

service_domain (Optional[str]):

service_port (Optional[int]):

use_system_messaging_server (bool):

provisioning_url (Optional[str]):

provisioning_user_id (Optional[str]):

bosh_url (Optional[str]):

default_imp_id_type (Optional[str]):

use_reseller_imp_id_setting (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderIntegratedIMPGetResponse22(OCIDataResponse):
    """Response to the ServiceProviderIntegratedIMPGetRequest22.
        The response contains the service provider Integrated IMP service attributes.
        If the service provider is within a reseller, useSystemServiceDomain means using reseller level service
        domain setting. And useSystemMessagingServer means using the reseller level messaging server setting.
        The element useResellerIMPIdSetting means using the reseller level IMP User ID setting.

    Attributes:

        use_system_service_domain (bool):

        service_domain (Optional[str]):

        service_port (Optional[int]):

        use_system_messaging_server (bool):

        provisioning_url (Optional[str]):

        provisioning_user_id (Optional[str]):

        bosh_url (Optional[str]):

        default_imp_id_type (Optional[str]):

        use_reseller_imp_id_setting (Optional[bool]):

    """

    use_system_service_domain: bool = field(
        metadata={"alias": "useSystemServiceDomain"}
    )

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

    service_port: Optional[int] = field(default=None, metadata={"alias": "servicePort"})

    use_system_messaging_server: bool = field(
        metadata={"alias": "useSystemMessagingServer"}
    )

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

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

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

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

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

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 ServiceProviderIntegratedIMPGetRequest22

client = Client()

command = ServiceProviderIntegratedIMPGetRequest22(
    service_provider_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("ServiceProviderIntegratedIMPGetRequest22",
    service_provider_id=...,
)

print(response)