Required role: | API |
All Verbs | /api/Query/MessageTemplate |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubManager.Api.Services.Query
Namespace Global
Namespace ClubManager.Api.Services.Query
<AutoQueryViewer(Description:="", IconUrl:="octicon:database", Title:="MessageTemplate")>
Public Partial Class FindMessageTemplate
Inherits QueryDb(Of MessageTemplateInstance)
End Class
Public Partial Class MessageTemplateInstance
Public Overridable Property MessageTemplateId As Integer
Public Overridable Property Name As String
Public Overridable Property Subject As String
Public Overridable Property Body As String
Public Overridable Property ReportId As Nullable(Of Integer)
Public Overridable Property TemplateType As Integer
Public Overridable Property Created As Nullable(Of Date)
Public Overridable Property CreatedBy As Nullable(Of Integer)
Public Overridable Property Modified As Nullable(Of Date)
Public Overridable Property ModifiedBy As Nullable(Of Integer)
Public Overridable Property Deleted As Nullable(Of Date)
Public Overridable Property DeletedBy As Nullable(Of Integer)
Public Overridable Property EventType As Integer
Public Overridable Property ContentType As Integer
Public Overridable Property Hidden As Nullable(Of Boolean)
Public Overridable Property ParentMessageTemplateId As Nullable(Of Integer)
Public Overridable Property InclusionTags As String
Public Overridable Property ExclusionTags As String
End Class
End Namespace
Namespace ServiceStack
<DataContract>
Public Partial Class QueryBase
Public Sub New()
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Skip As Nullable(Of Integer)
<DataMember(Order:=2)>
Public Overridable Property Take As Nullable(Of Integer)
<DataMember(Order:=3)>
Public Overridable Property OrderBy As String
<DataMember(Order:=4)>
Public Overridable Property OrderByDesc As String
<DataMember(Order:=5)>
Public Overridable Property Include As String
<DataMember(Order:=6)>
Public Overridable Property Fields As String
<DataMember(Order:=7)>
Public Overridable Property Meta As Dictionary(Of String, String)
End Class
Public Partial Class QueryDb(Of T)
Inherits QueryBase
End Class
<DataContract>
Public Partial Class QueryResponse(Of T)
Public Sub New()
Results = New List(Of T)
Meta = New Dictionary(Of String, String)
End Sub
<DataMember(Order:=1)>
Public Overridable Property Offset As Integer
<DataMember(Order:=2)>
Public Overridable Property Total As Integer
<DataMember(Order:=3)>
Public Overridable Property Results As List(Of T)
<DataMember(Order:=4)>
Public Overridable Property Meta As Dictionary(Of String, String)
<DataMember(Order:=5)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET FindMessageTemplate DTOs
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 /api/Query/MessageTemplate HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/jsv
Content-Type: text/jsv
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/jsv Content-Length: length { Offset: 0, Total: 0, Results: [ { MessageTemplateId: 0, Name: String, Subject: String, Body: String, ReportId: 0, TemplateType: 0, Created: 0001-01-01, CreatedBy: 0, Modified: 0001-01-01, ModifiedBy: 0, Deleted: 0001-01-01, 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 } } }