BokaMera.API.Host

TestSendMessageTemplate

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
POST	/messages/templates/test	Test to send a message to a Email or Mobile phone recepient using SMS.


export class MessageLogQueryResponse
{
    /** @description The message log id */
    // @ApiMember(Description="The message log id")
    public Id: number;

    /** @description The booking id for the message (if connected to a booking). */
    // @ApiMember(Description="The booking id for the message (if connected to a booking).")
    public BookingId?: number;

    /** @description The message receiver. Either a email or a mobile phone number. */
    // @ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
    public Receiver: string;

    /** @description Message Title. */
    // @ApiMember(Description="Message Title.")
    public MessageTitle: string;

    /** @description Message Storage Url. */
    // @ApiMember(Description="Message Storage Url.")
    public StorageUrl: string;

    /** @description Message Body. */
    // @ApiMember(Description="Message Body.")
    public MessageBody: string;

    /** @description When message was created. */
    // @ApiMember(Description="When message was created.")
    public Created: string;

    /** @description When the message will be sent. */
    // @ApiMember(Description="When the message will be sent.")
    public ToSendDate: string;

    /** @description When the message was sent. */
    // @ApiMember(Description="When the message was sent.")
    public SentDate?: string;

    /** @description If Message is sent */
    // @ApiMember(Description="If Message is sent")
    public Sent: boolean;

    /** @description Number of retries to send the message */
    // @ApiMember(Description="Number of retries to send the message")
    public MessageRetries: number;

    /** @description Send Method. 1 = Email, 2 = SMS */
    // @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    public SendMethodId: number;

    public constructor(init?: Partial<MessageLogQueryResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class TestSendMessageTemplate implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @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. */
    // @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)
    public Receiver: string;

    /** @description The message template title. */
    // @ApiMember(Description="The message template title.")
    public Title: string;

    /** @description The newsletter template body. */
    // @ApiMember(Description="The newsletter template body.", IsRequired=true)
    public Body: string;

    /** @description The message type id. See GET /messages/templates/types  */
    // @ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
    public TypeId: number;

    /** @description Message template lanugage */
    // @ApiMember(Description="Message template lanugage", IsRequired=true)
    public Language: string;

    /** @description The services that is connected to the message. If null it will be connected to all services. */
    // @ApiMember(Description="The services that is connected to the message. If null it will be connected to all services.")
    public Services: number[];

    public constructor(init?: Partial<TestSendMessageTemplate>) { (Object as any).assign(this, init); }
}

TypeScript TestSendMessageTemplate DTOs

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

HTTP + 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>