POST | /messages/sendemailtocompany | Send email to company with id or sitepath | This is used by the homepage to send emails to the company |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class MessageLogQueryResponse
'''<Summary>
'''The message log id
'''</Summary>
<ApiMember(Description:="The message log id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The booking id for the message (if connected to a booking).
'''</Summary>
<ApiMember(Description:="The booking id for the message (if connected to a booking).")>
Public Overridable Property BookingId As Nullable(Of Integer)
'''<Summary>
'''The message receiver. Either a email or a mobile phone number.
'''</Summary>
<ApiMember(Description:="The message receiver. Either a email or a mobile phone number.")>
Public Overridable Property Receiver As String
'''<Summary>
'''Message Title.
'''</Summary>
<ApiMember(Description:="Message Title.")>
Public Overridable Property MessageTitle As String
'''<Summary>
'''Message Storage Url.
'''</Summary>
<ApiMember(Description:="Message Storage Url.")>
Public Overridable Property StorageUrl As String
'''<Summary>
'''Message Body.
'''</Summary>
<ApiMember(Description:="Message Body.")>
Public Overridable Property MessageBody As String
'''<Summary>
'''When message was created.
'''</Summary>
<ApiMember(Description:="When message was created.")>
Public Overridable Property Created As Date
'''<Summary>
'''When the message will be sent.
'''</Summary>
<ApiMember(Description:="When the message will be sent.")>
Public Overridable Property ToSendDate As Date
'''<Summary>
'''When the message was sent.
'''</Summary>
<ApiMember(Description:="When the message was sent.")>
Public Overridable Property SentDate As Nullable(Of Date)
'''<Summary>
'''If Message is sent
'''</Summary>
<ApiMember(Description:="If Message is sent")>
Public Overridable Property Sent As Boolean
'''<Summary>
'''Number of retries to send the message
'''</Summary>
<ApiMember(Description:="Number of retries to send the message")>
Public Overridable Property MessageRetries As Integer
'''<Summary>
'''Send Method. 1 = Email, 2 = SMS
'''</Summary>
<ApiMember(Description:="Send Method. 1 = Email, 2 = SMS")>
Public Overridable Property SendMethodId As Integer
End Class
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
Public Partial Class SendEmailToCompany
Implements ICompany
'''<Summary>
'''The company id, if empty you will need to provide the sitepath instead.
'''</Summary>
<ApiMember(Description:="The company id, if empty you will need to provide the sitepath instead.")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''Message Title.
'''</Summary>
<ApiMember(Description:="Message Title.")>
Public Overridable Property MessageTitle As String
'''<Summary>
'''Message Body.
'''</Summary>
<ApiMember(Description:="Message Body.")>
Public Overridable Property MessageBody As String
'''<Summary>
'''Message Sender Name.
'''</Summary>
<ApiMember(Description:="Message Sender Name.")>
Public Overridable Property Name As String
'''<Summary>
'''Message Sender Email.
'''</Summary>
<ApiMember(Description:="Message Sender Email.")>
Public Overridable Property Email As String
'''<Summary>
'''Message Sender Phone Number.
'''</Summary>
<ApiMember(Description:="Message Sender Phone Number.")>
Public Overridable Property Phone As String
'''<Summary>
'''The homeage sitepath.
'''</Summary>
<ApiMember(Description:="The homeage sitepath.")>
Public Overridable Property SitePath As String
End Class
End Namespace
End Namespace
VB.NET SendEmailToCompany 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/sendemailtocompany HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SendEmailToCompany 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>
<Email>String</Email>
<MessageBody>String</MessageBody>
<MessageTitle>String</MessageTitle>
<Name>String</Name>
<Phone>String</Phone>
<SitePath>String</SitePath>
</SendEmailToCompany>
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>