ClubManager.Api

FindMessageTemplate

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/MessageTemplate

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
abstract class QueryBase
{
    // @DataMember(Order=1)
    int? Skip;

    // @DataMember(Order=2)
    int? Take;

    // @DataMember(Order=3)
    String? OrderBy;

    // @DataMember(Order=4)
    String? OrderByDesc;

    // @DataMember(Order=5)
    String? Include;

    // @DataMember(Order=6)
    String? Fields;

    // @DataMember(Order=7)
    Map<String,String?>? Meta;

    QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Skip = json['Skip'];
        Take = json['Take'];
        OrderBy = json['OrderBy'];
        OrderByDesc = json['OrderByDesc'];
        Include = json['Include'];
        Fields = json['Fields'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Skip': Skip,
        'Take': Take,
        'OrderBy': OrderBy,
        'OrderByDesc': OrderByDesc,
        'Include': Include,
        'Fields': Fields,
        'Meta': Meta
    };

    getTypeName() => "QueryBase";
    TypeContext? context = _ctx;
}

abstract class QueryDb<T> extends QueryBase
{
    QueryDb();
    QueryDb.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "QueryDb<$T>";
    TypeContext? context = _ctx;
}

class MessageTemplateInstance implements IConvertible
{
    int? MessageTemplateId;
    String? Name;
    String? Subject;
    String? Body;
    int? ReportId;
    int? TemplateType;
    DateTime? Created;
    int? CreatedBy;
    DateTime? Modified;
    int? ModifiedBy;
    DateTime? Deleted;
    int? DeletedBy;
    int? EventType;
    int? ContentType;
    bool? Hidden;
    int? ParentMessageTemplateId;
    String? InclusionTags;
    String? ExclusionTags;

    MessageTemplateInstance({this.MessageTemplateId,this.Name,this.Subject,this.Body,this.ReportId,this.TemplateType,this.Created,this.CreatedBy,this.Modified,this.ModifiedBy,this.Deleted,this.DeletedBy,this.EventType,this.ContentType,this.Hidden,this.ParentMessageTemplateId,this.InclusionTags,this.ExclusionTags});
    MessageTemplateInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MessageTemplateId = json['MessageTemplateId'];
        Name = json['Name'];
        Subject = json['Subject'];
        Body = json['Body'];
        ReportId = json['ReportId'];
        TemplateType = json['TemplateType'];
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        CreatedBy = json['CreatedBy'];
        Modified = JsonConverters.fromJson(json['Modified'],'DateTime',context!);
        ModifiedBy = json['ModifiedBy'];
        Deleted = JsonConverters.fromJson(json['Deleted'],'DateTime',context!);
        DeletedBy = json['DeletedBy'];
        EventType = json['EventType'];
        ContentType = json['ContentType'];
        Hidden = json['Hidden'];
        ParentMessageTemplateId = json['ParentMessageTemplateId'];
        InclusionTags = json['InclusionTags'];
        ExclusionTags = json['ExclusionTags'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MessageTemplateId': MessageTemplateId,
        'Name': Name,
        'Subject': Subject,
        'Body': Body,
        'ReportId': ReportId,
        'TemplateType': TemplateType,
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'CreatedBy': CreatedBy,
        'Modified': JsonConverters.toJson(Modified,'DateTime',context!),
        'ModifiedBy': ModifiedBy,
        'Deleted': JsonConverters.toJson(Deleted,'DateTime',context!),
        'DeletedBy': DeletedBy,
        'EventType': EventType,
        'ContentType': ContentType,
        'Hidden': Hidden,
        'ParentMessageTemplateId': ParentMessageTemplateId,
        'InclusionTags': InclusionTags,
        'ExclusionTags': ExclusionTags
    };

    getTypeName() => "MessageTemplateInstance";
    TypeContext? context = _ctx;
}

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MessageTemplate")
class FindMessageTemplate extends QueryDb<MessageTemplateInstance> implements IConvertible
{
    FindMessageTemplate();
    FindMessageTemplate.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "FindMessageTemplate";
    TypeContext? context = _ctx;
}

// @DataContract
class QueryResponse<T> implements IConvertible
{
    // @DataMember(Order=1)
    int? Offset;

    // @DataMember(Order=2)
    int? Total;

    // @DataMember(Order=3)
    List<T>? Results;

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Total = json['Total'];
        Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Total': Total,
        'Results': JsonConverters.toJson(Results,'List<T>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$T>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.clubmanagercentral.com', types: <String, TypeInfo> {
    'MessageTemplateInstance': TypeInfo(TypeOf.Class, create:() => MessageTemplateInstance()),
    'FindMessageTemplate': TypeInfo(TypeOf.Class, create:() => FindMessageTemplate()),
    'List<MessageTemplateInstance>': TypeInfo(TypeOf.Class, create:() => <MessageTemplateInstance>[]),
});

Dart 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
		}
	}
}