UserGetRegistrationListRequest

Bases: OCIRequest

Request to get a list of registrations for a user. The response is either a UserGetRegistrationListResponse or an ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserGetRegistrationListRequest(OCIRequest):
    """Request to get a list of registrations for a user.
        The response is either a UserGetRegistrationListResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

    user_id: str = field(metadata={"alias": "userId"})

Responses

Bases: OCIDataResponse

Response to UserGetRegistrationListRequest.

The registrationTable table column headings are:
  "Device Level", "Device Name", "Order", "URI", "Expiration", "Line/Port", "Endpoint Type", "Public Net Address", "Public Port", "Private Net Address", "Private Port", "User Agent", "Lockout Started", "Lockout Expires", "Lockout Count", "Access Info",
  "Private Identity", "SIP Instance ID", "Supports Only CS Media", "Feature Parameters", "Supports Voice Over PS", "Path Header", "Registration Active", "P-Access-Network-Info"
The following columns are only used in AS data mode:
  "Order", "Public Net Address", "Public Port", "Private Net Address", "Private Port", "Lockout Started", "Lockout Expires", "Lockout Count", "Path Header", "P-Access-Network-Info".
The following columns are only used in XS data mode:
  "Private Identity", "SIP Instance ID", "Supports Only CS Media", "Feature Parameters", "Supports Voice Over PS".
The following columns are only used in AS data mode:
  "Registration Active".
The "Device Level" column contains one of the AccessDeviceLevel enumerated constants.
The expiration column will be empty when the registration is static. In XS data mode, its value will be 0 when the registration is dynamic regardless of the registration's actual expiration date.
The Endpoint Type column contains one of the enumerated EndpointType values.
The Endpoint Type is empty when the registration is against a TELURI.
The table is sorted by: telURI (after SIPURI), Line/Port, static (after dynamic), order.
Lockout times are shown in GMT offset. When a permanent lockout is shown, the "Lockout Expires" column is empty and the "Lockout Count" column contains the word Permanent.

Attributes:

registration_table (OCITable):

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

@dataclass(kw_only=True)
class UserGetRegistrationListResponse(OCIDataResponse):
    """Response to UserGetRegistrationListRequest.

        The registrationTable table column headings are:
          \"Device Level\", \"Device Name\", \"Order\", \"URI\", \"Expiration\", \"Line/Port\", \"Endpoint Type\", \"Public Net Address\", \"Public Port\", \"Private Net Address\", \"Private Port\", \"User Agent\", \"Lockout Started\", \"Lockout Expires\", \"Lockout Count\", \"Access Info\",
          \"Private Identity\", \"SIP Instance ID\", \"Supports Only CS Media\", \"Feature Parameters\", \"Supports Voice Over PS\", \"Path Header\", \"Registration Active\", \"P-Access-Network-Info\"
        The following columns are only used in AS data mode:
          \"Order\", \"Public Net Address\", \"Public Port\", \"Private Net Address\", \"Private Port\", \"Lockout Started\", \"Lockout Expires\", \"Lockout Count\", \"Path Header\", \"P-Access-Network-Info\".
        The following columns are only used in XS data mode:
          \"Private Identity\", \"SIP Instance ID\", \"Supports Only CS Media\", \"Feature Parameters\", \"Supports Voice Over PS\".
        The following columns are only used in AS data mode:
          \"Registration Active\".
        The \"Device Level\" column contains one of the AccessDeviceLevel enumerated constants.
        The expiration column will be empty when the registration is static. In XS data mode, its value will be 0 when the registration is dynamic regardless of the registration's actual expiration date.
        The Endpoint Type column contains one of the enumerated EndpointType values.
        The Endpoint Type is empty when the registration is against a TELURI.
        The table is sorted by: telURI (after SIPURI), Line/Port, static (after dynamic), order.
        Lockout times are shown in GMT offset. When a permanent lockout is shown, the \"Lockout Expires\" column is empty and the \"Lockout Count\" column contains the word Permanent.

    Attributes:

        registration_table (OCITable):

    """

    registration_table: OCITable = field(metadata={"alias": "registrationTable"})

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 UserGetRegistrationListRequest

client = Client()

command = UserGetRegistrationListRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserGetRegistrationListRequest",
    user_id=...,
)

print(response)