| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/send | Send a newsletter to a customers. |
|---|
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 SendNewslettersResponse() =
///<summary>
///The number of messages that are added into queue.
///</summary>
[<ApiMember(Description="The number of messages that are added into queue.")>]
member val Total: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
///<summary>
///Message example sent (in HTML format)
///</summary>
[<ApiMember(Description="Message example sent (in HTML format)")>]
member val MessageExample:String = null with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type SendNewsLetter() =
///<summary>
///The newsletter template id.
///</summary>
[<ApiMember(Description="The newsletter template id.", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<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.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The datetime when the newsletters should be sent.
///</summary>
[<ApiMember(Description="The datetime when the newsletters should be sent.", IsRequired=true)>]
member val SendDate:DateTime = new DateTime() with get,set
///<summary>
///The customer ids to send newsletters to.
///</summary>
[<ApiMember(Description="The customer ids to send newsletters to.", IsRequired=true)>]
member val Customers:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
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 /newsletter/send HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
CompanyId: 00000000-0000-0000-0000-000000000000,
Customers:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Total: 0,
SendMethodId: 0,
MessageExample: String
}