| Required role: | API |
| All Verbs | /api/Query/MessageTemplate |
|---|
namespace ClubManager.Api.Services.Query
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type MessageTemplateInstance() =
member val MessageTemplateId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Subject:String = null with get,set
member val Body:String = null with get,set
member val ReportId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val TemplateType:Int32 = new Int32() with get,set
member val Created:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CreatedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Modified:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ModifiedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Deleted:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DeletedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
member val EventType:Int32 = new Int32() with get,set
member val ContentType:Int32 = new Int32() with get,set
member val Hidden:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val ParentMessageTemplateId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val InclusionTags:String = null with get,set
member val ExclusionTags:String = null with get,set
[<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MessageTemplate")>]
[<AllowNullLiteral>]
type FindMessageTemplate() =
inherit QueryDb<MessageTemplateInstance>()
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
[<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<'T>() =
inherit QueryBase()
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<'T>() =
[<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<'T> = new ResizeArray<'T>() 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
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.
POST /api/Query/MessageTemplate HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"MessageTemplateId":0,"Name":"String","Subject":"String","Body":"String","ReportId":0,"TemplateType":0,"Created":"0001-01-01T00:00:00.0000000","CreatedBy":0,"Modified":"0001-01-01T00:00:00.0000000","ModifiedBy":0,"Deleted":"0001-01-01T00:00:00.0000000","DeletedBy":0,"EventType":0,"ContentType":0,"Hidden":false,"ParentMessageTemplateId":0,"InclusionTags":"String","ExclusionTags":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}