BokaMera.API.Host

<back to all web services

CreateMessageTemplate

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/messages/templatesCreate a new company message templatesCreate a new company message templates.
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 MessageTypeQueryResponse:
    # @ApiMember(Description="The message type id")
    id: int = 0
    """
    The message type id
    """


    # @ApiMember(Description="The message type name.")
    name: Optional[str] = None
    """
    The message type name.
    """


    # @ApiMember(Description="The message type description.")
    description: Optional[str] = None
    """
    The message type description.
    """


    # @ApiMember(Description="The maximum number of charachters that can be entered into message body using this type.")
    max_characters: int = 0
    """
    The maximum number of charachters that can be entered into message body using this type.
    """


    # @ApiMember(Description="The default text that is always included when sending messages of this type.")
    default_text: Optional[str] = None
    """
    The default text that is always included when sending messages of this type.
    """


    # @ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")
    send_method_id: int = 0
    """
    The send method for this type. 1 = Email, 2 = SMS.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessageServices:
    id: int = 0
    # @ApiMember(Description="Name of the service")
    name: Optional[str] = None
    """
    Name of the service
    """


    # @ApiMember(Description="The image url of the service")
    image_url: Optional[str] = None
    """
    The image url of the service
    """


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


    # @ApiMember(Description="The message template name.")
    name: Optional[str] = None
    """
    The message template name.
    """


    # @ApiMember(Description="The message template title.")
    title: Optional[str] = None
    """
    The message template title.
    """


    # @ApiMember(Description="The message template title.")
    body: Optional[str] = None
    """
    The message template title.
    """


    # @ApiMember(Description="The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).")
    sender: Optional[str] = None
    """
    The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).
    """


    # @ApiMember(Description="If the message template is the default message currently in use.")
    default: bool = False
    """
    If the message template is the default message currently in use.
    """


    # @ApiMember(Description="If the message type information.")
    message_type: Optional[MessageTypeQueryResponse] = None
    """
    If the message type information.
    """


    # @ApiMember(Description="Template language.")
    language: Optional[str] = None
    """
    Template language.
    """


    # @ApiMember(Description="The connected services which the template is valid for. If empty then it's valid for all services.")
    services: Optional[List[MessageServices]] = None
    """
    The connected services which the template is valid for. If empty then it's valid for all services.
    """


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateMessageTemplate(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
    type_id: int = 0
    """
    The message type id. See GET /messages/templates/types 
    """


    # @ApiMember(Description="The message template name.", IsRequired=true)
    name: Optional[str] = None
    """
    The message template name.
    """


    # @ApiMember(Description="The message template title.", IsRequired=true)
    title: Optional[str] = None
    """
    The message template title.
    """


    # @ApiMember(Description="The message template title.", IsRequired=true)
    body: Optional[str] = None
    """
    The message template title.
    """


    # @ApiMember(Description="The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).")
    sender: Optional[str] = None
    """
    The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).
    """


    # @ApiMember(Description="Template Language sv / en")
    language: Optional[str] = None
    """
    Template Language sv / en
    """


    # @ApiMember(Description="The services that is connected to the template. If null it will be connected to all services.")
    services: Optional[List[int]] = None
    """
    The services that is connected to the template. If null it will be connected to all services.
    """

Python CreateMessageTemplate 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/templates HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","TypeId":0,"Name":"String","Title":"String","Body":"String","Sender":"String","Language":"String","Services":[0]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"Name":"String","Title":"String","Body":"String","Sender":"String","Default":false,"MessageType":{"Id":0,"Name":"String","Description":"String","MaxCharacters":0,"DefaultText":"String","SendMethodId":0},"Language":"String","Services":[{"Id":0,"Name":"String"}]}