ClubManager.Api

FindMessageTemplate

**Requires Authentication**
Required role:	API

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


// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

export class MessageTemplateInstance
{
    public MessageTemplateId?: number;
    public Name?: string;
    public Subject?: string;
    public Body?: string;
    public ReportId?: number;
    public TemplateType?: number;
    public Created?: string;
    public CreatedBy?: number;
    public Modified?: string;
    public ModifiedBy?: number;
    public Deleted?: string;
    public DeletedBy?: number;
    public EventType?: number;
    public ContentType?: number;
    public Hidden?: boolean;
    public ParentMessageTemplateId?: number;
    public InclusionTags?: string;
    public ExclusionTags?: string;

    public constructor(init?: Partial<MessageTemplateInstance>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<FindMessageTemplate>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset?: number;

    // @DataMember(Order=2)
    public Total?: number;

    // @DataMember(Order=3)
    public Results?: T[];

    // @DataMember(Order=4)
    public Meta?: { [index: string]: string; };

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

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

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