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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NewsletterLogQueryResponse() = 
        ///<summary>
        ///The message log id
        ///</summary>
        [<ApiMember(Description="The message log id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<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.")>]
        member val Receiver:String = null with get,set

        ///<summary>
        ///Nessage Title.
        ///</summary>
        [<ApiMember(Description="Nessage Title.")>]
        member val MessageTitle:String = null with get,set

        ///<summary>
        ///Nessage Body.
        ///</summary>
        [<ApiMember(Description="Nessage Body.")>]
        member val MessageBody:String = null with get,set

        ///<summary>
        ///When message was created.
        ///</summary>
        [<ApiMember(Description="When message was created.")>]
        member val Created:DateTime = new DateTime() with get,set

        ///<summary>
        ///When the message will be sent.
        ///</summary>
        [<ApiMember(Description="When the message will be sent.")>]
        member val ToSendDate:DateTime = new DateTime() with get,set

        ///<summary>
        ///When the message was sent.
        ///</summary>
        [<ApiMember(Description="When the message was sent.")>]
        member val SentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///If Message is sent
        ///</summary>
        [<ApiMember(Description="If Message is sent")>]
        member val Sent:Boolean = new Boolean() with get,set

        ///<summary>
        ///Number of retries to send the message
        ///</summary>
        [<ApiMember(Description="Number of retries to send the message")>]
        member val MessageRetries:Int32 = new Int32() with get,set

        ///<summary>
        ///Send Method. 1 = Email, 2 = SMS
        ///</summary>
        [<ApiMember(Description="Send Method. 1 = Email, 2 = SMS")>]
        member val SendMethodId:Int32 = new Int32() with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type NewsletterResendMessage() = 
        ///<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")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Newsletter message Id
        ///</summary>
        [<ApiMember(DataType="int", Description="Newsletter message Id", ParameterType="path")>]
        member val Id:Int32 = new Int32() with get,set

F# NewsletterResendMessage DTOs

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.

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

<NewsletterResendMessage 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>
</NewsletterResendMessage>
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>