ClubManager.Api

<back to all web services

FindMessageTemplate

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/MessageTemplate
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MessageTemplate")
open class FindMessageTemplate : QueryDb<MessageTemplateInstance>()
{
}

open class QueryDb<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    var Skip:Int? = null

    @DataMember(Order=2)
    var Take:Int? = null

    @DataMember(Order=3)
    var OrderBy:String? = null

    @DataMember(Order=4)
    var OrderByDesc:String? = null

    @DataMember(Order=5)
    var Include:String? = null

    @DataMember(Order=6)
    var Fields:String? = null

    @DataMember(Order=7)
    var Meta:HashMap<String,String> = HashMap<String,String>()
}

open class MessageTemplateInstance
{
    var MessageTemplateId:Int? = null
    var Name:String? = null
    var Subject:String? = null
    var Body:String? = null
    var ReportId:Int? = null
    var TemplateType:Int? = null
    var Created:Date? = null
    var CreatedBy:Int? = null
    var Modified:Date? = null
    var ModifiedBy:Int? = null
    var Deleted:Date? = null
    var DeletedBy:Int? = null
    var EventType:Int? = null
    var ContentType:Int? = null
    var Hidden:Boolean? = null
    var ParentMessageTemplateId:Int? = null
    var InclusionTags:String? = null
    var ExclusionTags:String? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    var Offset:Int? = null

    @DataMember(Order=2)
    var Total:Int? = null

    @DataMember(Order=3)
    var Results:ArrayList<T> = ArrayList<T>()

    @DataMember(Order=4)
    var Meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var ResponseStatus:ResponseStatus? = null
}

Kotlin FindMessageTemplate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}