| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| POST | /messages/templates/test | Test to send a message to a Email or Mobile phone recepient using SMS. |
|---|
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)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestSendMessageTemplate(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 email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.", IsRequired=true)
receiver: Optional[str] = None
"""
The email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.
"""
# @ApiMember(Description="The message template title.")
title: Optional[str] = None
"""
The message template title.
"""
# @ApiMember(Description="The newsletter template body.", IsRequired=true)
body: Optional[str] = None
"""
The newsletter template body.
"""
# @ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
type_id: Optional[int] = None
"""
The message type id. See GET /messages/templates/types
"""
# @ApiMember(Description="Message template lanugage", IsRequired=true)
language: Optional[str] = None
"""
Message template lanugage
"""
# @ApiMember(Description="The services that is connected to the message. If null it will be connected to all services.")
services: Optional[List[int]] = None
"""
The services that is connected to the message. If null it will be connected to all services.
"""
Python TestSendMessageTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /messages/templates/test HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<TestSendMessageTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Language>String</Language>
<Receiver>String</Receiver>
<Services xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</Services>
<Title>String</Title>
<TypeId>0</TypeId>
</TestSendMessageTemplate>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <MessageLogQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <BookingId>0</BookingId> <Created>0001-01-01T00:00:00</Created> <Id>0</Id> <MessageBody>String</MessageBody> <MessageRetries>0</MessageRetries> <MessageTitle>String</MessageTitle> <Receiver>String</Receiver> <SendMethodId>0</SendMethodId> <Sent>false</Sent> <SentDate>0001-01-01T00:00:00</SentDate> <StorageUrl>String</StorageUrl> <ToSendDate>0001-01-01T00:00:00</ToSendDate> </MessageLogQueryResponse>