BokaMera.API.Host

<back to all web services

NewsletterResendMessage

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/newsletter/log/{Id}/resendResend a message from the logResend a message from the log to the recepient.
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 NewsletterLogQueryResponse
            '''<Summary>
            '''The message log id
            '''</Summary>
            <ApiMember(Description:="The message log id")>
            Public Overridable Property Id As 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>
            '''Nessage Title.
            '''</Summary>
            <ApiMember(Description:="Nessage Title.")>
            Public Overridable Property MessageTitle As String

            '''<Summary>
            '''Nessage Body.
            '''</Summary>
            <ApiMember(Description:="Nessage 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 NewsletterResendMessage
            Implements ICompany
            '''<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.", ParameterType:="path")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Newsletter message Id
            '''</Summary>
            <ApiMember(DataType:="int", Description:="Newsletter message Id", ParameterType:="path")>
            Public Overridable Property Id As Integer
        End Class
    End Namespace
End Namespace

VB.NET NewsletterResendMessage DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /newsletter/log/{Id}/resend HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Receiver: String,
	MessageTitle: String,
	MessageBody: String,
	SentDate: "0001-01-01T00:00:00",
	Sent: False,
	MessageRetries: 0,
	SendMethodId: 0
}