BokaMera.API.Host

TestSendNewsLetter

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

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

**TestSendNewsLetter** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	body	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
Receiver	body	string	Yes	The email recipient 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.
Id	body	int	Yes	The newsletter template id.

**NewsletterLogQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The message log id
Receiver	form	string	Yes	The message receiver. Either a email or a mobile phone number.
MessageTitle	form	string	Yes	Nessage Title.
MessageBody	form	string	Yes	Nessage Body.
Created	form	DateTime	No	When message was created.
ToSendDate	form	DateTime	No	When the message will be sent.
SentDate	form	DateTime?	No	When the message was sent.
Sent	form	bool	No	If Message is sent
MessageRetries	form	int	No	Number of retries to send the message
SendMethodId	form	int	No	Send Method. 1 = Email, 2 = SMS

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 /newsletter/templates/test HTTP/1.1 
Host: testapi.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>