| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/templates | Get company newsletter templates | Get all company newsletter templates. |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type NewsletterSendMethodQueryResponse() =
///<summary>
///The send method id
///</summary>
[<ApiMember(Description="The send method id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The send method name.
///</summary>
[<ApiMember(Description="The send method name.")>]
member val Name:String = null with get,set
///<summary>
///The send method description.
///</summary>
[<ApiMember(Description="The send method description.")>]
member val Description:String = null with get,set
[<AllowNullLiteral>]
type NewsletterEmailTemplatesQueryResponse() =
///<summary>
///The email template id
///</summary>
[<ApiMember(Description="The email template id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The email template name.
///</summary>
[<ApiMember(Description="The email template name.")>]
member val Name:String = null with get,set
///<summary>
///The email template description.
///</summary>
[<ApiMember(Description="The email template description.")>]
member val Description:String = null with get,set
///<summary>
///The email template html content.
///</summary>
[<ApiMember(Description="The email template html content.")>]
member val Body:String = null with get,set
[<AllowNullLiteral>]
type NewsletterTemplatesQueryResponse() =
///<summary>
///The newsletter template id
///</summary>
[<ApiMember(Description="The newsletter template id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The newsletter template heading.
///</summary>
[<ApiMember(Description="The newsletter template heading.")>]
member val Heading:String = null with get,set
///<summary>
///The newsletter template body.
///</summary>
[<ApiMember(Description="The newsletter template body.")>]
member val Body:String = null with get,set
///<summary>
///The email template the newsletter uses.
///</summary>
[<ApiMember(Description="The email template the newsletter uses.")>]
member val EmailTemplateId:Nullable<Int32> = new Nullable<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>
///The newsletter template image url.
///</summary>
[<ApiMember(Description="The newsletter template image url.")>]
member val ImageUrl:String = null with get,set
///<summary>
///The newsletter created date.
///</summary>
[<ApiMember(Description="The newsletter created date.")>]
member val Created:DateTime = new DateTime() with get,set
///<summary>
///Send method information.
///</summary>
[<ApiMember(Description="Send method information.")>]
member val SendMethodInformation:NewsletterSendMethodQueryResponse = null with get,set
///<summary>
///Email template information.
///</summary>
[<ApiMember(Description="Email template information.")>]
member val EmailTemplateInformation:NewsletterEmailTemplatesQueryResponse = null with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type SendMethod() =
inherit BaseModel()
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val Description:String = null with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
member val Id:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type EmailTemplate() =
inherit BaseModel()
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val Description:String = null with get,set
[<Required>]
member val Body:String = null with get,set
[<Required>]
member val Type:Int32 = new Int32() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
member val Id:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type NewsletterTemplate() =
inherit BaseModel()
member val SendMethod:SendMethod = null with get,set
member val EmailTemplate:EmailTemplate = null with get,set
[<Required>]
member val CompanyId:Guid = new Guid() with get,set
member val Id:Int32 = new Int32() with get,set
[<Required>]
member val Heading:String = null with get,set
[<Required>]
member val Body:String = null with get,set
member val ImageUrl:String = null with get,set
[<Required>]
member val SendMethodId:Int32 = new Int32() with get,set
member val EmailTemplateId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<Required>]
member val Created:DateTime = new DateTime() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type NewsletterTemplatesQuery() =
inherit QueryDb<NewsletterTemplate, NewsletterTemplatesQueryResponse>()
///<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 newsletter template id.
///</summary>
[<ApiMember(Description="The newsletter template id.")>]
member val Id:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///If you want to include the message send method information
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the message send method information", ParameterType="query")>]
member val IncludeSendMethodInformation:Boolean = new Boolean() with get,set
///<summary>
///If you want to include the email template information
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the email template information", ParameterType="query")>]
member val IncludeEmailTemplateInformation:Boolean = new Boolean() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
///<summary>
///Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
///</summary>
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
///</summary>
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
///</summary>
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
///<summary>
///Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
///</summary>
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
///<summary>
///Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
///</summary>
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<AccessKeyTypeResponse>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = new ResizeArray<AccessKeyTypeResponse>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
F# NewsletterTemplatesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /newsletter/templates HTTP/1.1 Host: api.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Heading":"String","Body":"String","EmailTemplateId":0,"SendMethodId":0,"ImageUrl":"String","SendMethodInformation":{"Id":0,"Name":"String","Description":"String"},"EmailTemplateInformation":{"Id":0,"Name":"String","Description":"String","Body":"String"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}