UserSeriesCompletionGetRequest

Bases: OCIRequest

Gets the details of the Series Completion group that a user belongs to (if any). Any user can only belong to one Series Completion group. The response is either UserSeriesCompletionGetResponse or ErrorResponse.

Attributes:

user_id (str):

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

@dataclass(kw_only=True)
class UserSeriesCompletionGetRequest(OCIRequest):
    """Gets the details of the Series Completion group that a user belongs to (if any).
        Any user can only belong to one Series Completion group.
        The response is either UserSeriesCompletionGetResponse or ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to the UserSeriesCompletionGetRequest. Identifies which Series Completion group the user belongs to and the list of users in the group. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Department", "Phone Number", "Extension", "Email Address".

Attributes:

name (Optional[str]):

user_table (OCITable):

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

@dataclass(kw_only=True)
class UserSeriesCompletionGetResponse(OCIDataResponse):
    """Response to the UserSeriesCompletionGetRequest.
        Identifies which Series Completion group the user belongs to and the list of users in the group.
        Contains a table with column headings: \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\",
        \"Hiragana First Name\", \"Department\", \"Phone Number\", \"Extension\", \"Email Address\".

    Attributes:

        name (Optional[str]):

        user_table (OCITable):

    """

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

    user_table: OCITable = field(metadata={"alias": "userTable"})

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 UserSeriesCompletionGetRequest

client = Client()

command = UserSeriesCompletionGetRequest(
    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("UserSeriesCompletionGetRequest",
    user_id=...,
)

print(response)