UserBroadWorksReceptionistEnterpriseNoteGetRequest

Bases: OCIRequest

Request the Receptionist notes for the specified Receptionist and Contact User IDs. The response is either a UserBroadWorksReceptionistEnterpriseNoteGetResponse or an ErrorResponse. If the user sending the request is the not the owner of the Receptionist Note, then an ErrorResponse will be returned.

Attributes:

receptionist_user_id (str):

contact_user_id (Optional[str]):

von_user (Optional[VirtualOnNetUserKey]):

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

@dataclass(kw_only=True)
class UserBroadWorksReceptionistEnterpriseNoteGetRequest(OCIRequest):
    """Request the Receptionist notes for the specified Receptionist and Contact User IDs.
        The response is either a UserBroadWorksReceptionistEnterpriseNoteGetResponse or an
        ErrorResponse.  If the user sending the request is the not the owner of the
        Receptionist Note, then an ErrorResponse will be returned.

    Attributes:

        receptionist_user_id (str):

        contact_user_id (Optional[str]):

        von_user (Optional[VirtualOnNetUserKey]):

    """

    receptionist_user_id: str = field(metadata={"alias": "receptionistUserId"})

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

    von_user: Optional[VirtualOnNetUserKey] = field(
        default=None, metadata={"alias": "vonUser"}
    )

Responses

Bases: OCIDataResponse

Response to UserBroadWorksReceptionistEnterpriseNoteGetRequest.

Attributes:

receptionist_note (Optional[str]):

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

@dataclass(kw_only=True)
class UserBroadWorksReceptionistEnterpriseNoteGetResponse(OCIDataResponse):
    """Response to UserBroadWorksReceptionistEnterpriseNoteGetRequest.

    Attributes:

        receptionist_note (Optional[str]):

    """

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

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

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 UserBroadWorksReceptionistEnterpriseNoteGetRequest

client = Client()

command = UserBroadWorksReceptionistEnterpriseNoteGetRequest(
    receptionist_user_id=...,
    contact_user_id=...,
    von_user=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("UserBroadWorksReceptionistEnterpriseNoteGetRequest",
    receptionist_user_id=...,
    contact_user_id=...,
    von_user=...,
)

print(response)