SystemGetRegistrationContactListRequest21sp1

Bases: OCIRequest

Get the list of registration contacts. This request handles all levels of administration privileges. The content of the response will only contain items within the scope of the requester's login id. At the system level any of the choice parameters may be specified to filter the registrations listed. At the reseller level, the resellerId must be specified. ResellerId is not valid at service provider, group or user level. At the service provider level the serviceProviderId must be specified for the service provider and group options. When using the userId or linePort options the specified value must be valid for that service provider login. At the group level the servicProviderId and the groupId must be specified for the group option. When using the userId or linePort options the specified value must be valid for that group login. The serviceProviderId option is not valid at the group level. At the user level when using the userId or linePort options the specified value must be valid for that user login. The serviceProviderId and groupId options are not valid at the user level. The response is either SystemGetRegistrationContactListResponse21sp1 or ErrorResponse. The RegistrationEndpointType21sp1 is sent in response The Endpoint Type column contains one of the enumerated RegistrationEndpointType21sp1 values. The value Mobility in Endpoint Type column is only applicable in AS data mode.

The following elements are only used in AS data mode:
  resellerId

Attributes:

reseller_id (Optional[str]):

service_provider_id (Optional[str]):

svc_provider_id (Optional[str]):

group_id (Optional[str]):

user_id (Optional[str]):

line_port (Optional[str]):

device_level (Optional[str]):

device_name (Optional[str]):

device_type (Optional[str]):

search_criteria_registration_uri (Optional[List[SearchCriteriaRegistrationURI]]):

search_criteria_sip_contact (Optional[List[SearchCriteriaSIPContact]]):

endpoint_type (Optional[str]):

expired (Optional[bool]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class SystemGetRegistrationContactListRequest21sp1(OCIRequest):
    """Get the list of registration contacts.
        This request handles all levels of administration privileges.  The content of the response will only contain
        items within the scope of the requester's login id.  At the system level any of the choice parameters may be
        specified to filter the registrations listed.  At the reseller level, the resellerId must be specified.
        ResellerId is not valid at service provider, group or user level. At the service provider level the
        serviceProviderId must be specified for the service provider and group options.  When using the userId or
        linePort options the specified value must be valid for that service provider login.  At the group level
        the servicProviderId and the groupId must be specified for the group option. When using the userId or linePort
        options the specified value must be valid for that group login.
        The serviceProviderId option is not valid at the group level.  At the user level when using the userId or
        linePort options the specified value must be valid for that user login.  The serviceProviderId and groupId
        options are not valid at the user level.
        The response is either SystemGetRegistrationContactListResponse21sp1 or ErrorResponse.
        The RegistrationEndpointType21sp1 is sent in response The Endpoint Type column contains one of the enumerated RegistrationEndpointType21sp1 values.
        The value Mobility in Endpoint Type column is only applicable in AS data mode.

        The following elements are only used in AS data mode:
          resellerId

    Attributes:

        reseller_id (Optional[str]):

        service_provider_id (Optional[str]):

        svc_provider_id (Optional[str]):

        group_id (Optional[str]):

        user_id (Optional[str]):

        line_port (Optional[str]):

        device_level (Optional[str]):

        device_name (Optional[str]):

        device_type (Optional[str]):

        search_criteria_registration_uri (Optional[List[SearchCriteriaRegistrationURI]]):

        search_criteria_sip_contact (Optional[List[SearchCriteriaSIPContact]]):

        endpoint_type (Optional[str]):

        expired (Optional[bool]):

    """

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

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

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

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

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

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

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

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

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

    search_criteria_registration_uri: Optional[List[SearchCriteriaRegistrationURI]] = (
        field(default=None, metadata={"alias": "searchCriteriaRegistrationURI"})
    )

    search_criteria_sip_contact: Optional[List[SearchCriteriaSIPContact]] = field(
        default=None, metadata={"alias": "searchCriteriaSIPContact"}
    )

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

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

Responses

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 SystemGetRegistrationContactListRequest21sp1

client = Client()

command = SystemGetRegistrationContactListRequest21sp1(
    reseller_id=...,
    service_provider_id=...,
    svc_provider_id=...,
    group_id=...,
    user_id=...,
    line_port=...,
    device_level=...,
    device_name=...,
    device_type=...,
    search_criteria_registration_uri=...,
    search_criteria_sip_contact=...,
    endpoint_type=...,
    expired=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemGetRegistrationContactListRequest21sp1",
    reseller_id=...,
    service_provider_id=...,
    svc_provider_id=...,
    group_id=...,
    user_id=...,
    line_port=...,
    device_level=...,
    device_name=...,
    device_type=...,
    search_criteria_registration_uri=...,
    search_criteria_sip_contact=...,
    endpoint_type=...,
    expired=...,
)

print(response)