Skip to content

UserBroadWorksReceptionistSmallBusinessGetRequest

Bases: OCIRequest

Request the Receptionist Small Business parameters. The response is either a UserBroadWorksReceptionistSmallBusinessGetResponse or an ErrorResponse.

Attributes:

user_id (str):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksReceptionistSmallBusinessGetRequest(OCIRequest):
    """Request the Receptionist Small Business parameters.
        The response is either a UserBroadWorksReceptionistSmallBusinessGetResponse or an ErrorResponse.

    Attributes:

        user_id (str):

    """

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

Responses

Bases: OCIDataResponse

Response to UserBroadWorksReceptionistSmallBusinessGetRequest. Returns a 12 column table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id", "Title".

Attributes:

monitored_user_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class UserBroadWorksReceptionistSmallBusinessGetResponse(OCIDataResponse):
    """Response to UserBroadWorksReceptionistSmallBusinessGetRequest.
        Returns a 12 column table with column headings:
          \"User Id\", \"Last Name\", \"First Name\", \"Hiragana Last Name\", \"Hiragana First Name\",
          \"Group Id\", \"Phone Number\", \"Extension\", \"Mobile\", \"Email Address\", \"Department\", \"IMP Id\", \"Title\".

    Attributes:

        monitored_user_table (OCITable):

    """

    monitored_user_table: OCITable = field(metadata={"alias": "monitoredUserTable"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import UserBroadWorksReceptionistSmallBusinessGetRequest

client = Client()

command = UserBroadWorksReceptionistSmallBusinessGetRequest(
    user_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

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

print(response)