| 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. |
|---|
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)>
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class TestSendMessageTemplate
Implements ICompany
Public Sub New()
Services = New Integer(){}
End Sub
'''<Summary>
'''The company id, if empty will use the company id for the user you are logged in with.
'''</Summary>
<ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''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.
'''</Summary>
<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 Overridable Property Receiver As String
'''<Summary>
'''The message template title.
'''</Summary>
<ApiMember(Description:="The message template title.")>
Public Overridable Property Title As String
'''<Summary>
'''The newsletter template body.
'''</Summary>
<ApiMember(Description:="The newsletter template body.", IsRequired:=true)>
Public Overridable Property Body As String
'''<Summary>
'''The message type id. See GET /messages/templates/types
'''</Summary>
<ApiMember(Description:="The message type id. See GET /messages/templates/types ", IsRequired:=true)>
Public Overridable Property TypeId As Nullable(Of Integer)
'''<Summary>
'''Message template lanugage
'''</Summary>
<ApiMember(Description:="Message template lanugage", IsRequired:=true)>
Public Overridable Property Language As String
'''<Summary>
'''The services that is connected to the message. If null it will be connected to all services.
'''</Summary>
<ApiMember(Description:="The services that is connected to the message. If null it will be connected to all services.")>
Public Overridable Property Services As Integer()
End Class
End Namespace
End Namespace
VB.NET TestSendMessageTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Receiver: String,
Title: String,
Body: String,
TypeId: 0,
Language: String,
Services:
[
0
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
BookingId: 0,
Receiver: String,
MessageTitle: String,
StorageUrl: String,
MessageBody: String,
SentDate: "0001-01-01T00:00:00",
Sent: False,
MessageRetries: 0,
SendMethodId: 0
}