| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/templates/test | Test to send a newsletter to a Email or Mobile phone recepient using SMS. |
|---|
export class NewsletterLogQueryResponse
{
/** @description The message log id */
// @ApiMember(Description="The message log id")
public Id: 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 Nessage Title. */
// @ApiMember(Description="Nessage Title.")
public MessageTitle: string;
/** @description Nessage Body. */
// @ApiMember(Description="Nessage 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<NewsletterLogQueryResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class TestSendNewsLetter 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 newsletter template id. */
// @ApiMember(Description="The newsletter template id.", IsRequired=true)
public Id: number;
public constructor(init?: Partial<TestSendNewsLetter>) { (Object as any).assign(this, init); }
}
TypeScript TestSendNewsLetter 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 /newsletter/templates/test HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<TestSendNewsLetter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>0</Id>
<Receiver>String</Receiver>
</TestSendNewsLetter>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <NewsletterLogQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <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> <ToSendDate>0001-01-01T00:00:00</ToSendDate> </NewsletterLogQueryResponse>