BokaMera.API.Host

<back to all web services

SendEmailToCompany

The following routes are available for this service:
POST/messages/sendemailtocompanySend email to company with id or sitepathThis is used by the homepage to send emails to the company
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessageLogQueryResponse:
    # @ApiMember(Description="The message log id")
    id: int = 0
    """
    The message log id
    """


    # @ApiMember(Description="The booking id for the message (if connected to a booking).")
    booking_id: Optional[int] = None
    """
    The booking id for the message (if connected to a booking).
    """


    # @ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
    receiver: Optional[str] = None
    """
    The message receiver. Either a email or a mobile phone number.
    """


    # @ApiMember(Description="Message Title.")
    message_title: Optional[str] = None
    """
    Message Title.
    """


    # @ApiMember(Description="Message Storage Url.")
    storage_url: Optional[str] = None
    """
    Message Storage Url.
    """


    # @ApiMember(Description="Message Body.")
    message_body: Optional[str] = None
    """
    Message Body.
    """


    # @ApiMember(Description="When message was created.")
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    When message was created.
    """


    # @ApiMember(Description="When the message will be sent.")
    to_send_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    When the message will be sent.
    """


    # @ApiMember(Description="When the message was sent.")
    sent_date: Optional[datetime.datetime] = None
    """
    When the message was sent.
    """


    # @ApiMember(Description="If Message is sent")
    sent: bool = False
    """
    If Message is sent
    """


    # @ApiMember(Description="Number of retries to send the message")
    message_retries: int = 0
    """
    Number of retries to send the message
    """


    # @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    send_method_id: int = 0
    """
    Send Method. 1 = Email, 2 = SMS
    """


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendEmailToCompany(ICompany):
    # @ApiMember(Description="The company id, if empty you will need to provide the sitepath instead.")
    company_id: Optional[str] = None
    """
    The company id, if empty you will need to provide the sitepath instead.
    """


    # @ApiMember(Description="Message Title.")
    message_title: Optional[str] = None
    """
    Message Title.
    """


    # @ApiMember(Description="Message Body.")
    message_body: Optional[str] = None
    """
    Message Body.
    """


    # @ApiMember(Description="Message Sender Name.")
    name: Optional[str] = None
    """
    Message Sender Name.
    """


    # @ApiMember(Description="Message Sender Email.")
    email: Optional[str] = None
    """
    Message Sender Email.
    """


    # @ApiMember(Description="Message Sender Phone Number.")
    phone: Optional[str] = None
    """
    Message Sender Phone Number.
    """


    # @ApiMember(Description="The homeage sitepath.")
    site_path: Optional[str] = None
    """
    The homeage sitepath.
    """

Python SendEmailToCompany DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /messages/sendemailtocompany HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","MessageTitle":"String","MessageBody":"String","Name":"String","Email":"String","Phone":"String","SitePath":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"BookingId":0,"Receiver":"String","MessageTitle":"String","StorageUrl":"String","MessageBody":"String","SentDate":"0001-01-01T00:00:00","Sent":false,"MessageRetries":0,"SendMethodId":0}