| Required role: | API |
| All Verbs | /api/Query/MessageTemplate |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubManager.Api.Services.Query;
namespace ClubManager.Api.Services.Query
{
[AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MessageTemplate")]
public partial class FindMessageTemplate
: QueryDb<MessageTemplateInstance>
{
}
public partial class MessageTemplateInstance
{
public virtual int MessageTemplateId { get; set; }
public virtual string Name { get; set; }
public virtual string Subject { get; set; }
public virtual string Body { get; set; }
public virtual int? ReportId { get; set; }
public virtual int TemplateType { get; set; }
public virtual DateTime? Created { get; set; }
public virtual int? CreatedBy { get; set; }
public virtual DateTime? Modified { get; set; }
public virtual int? ModifiedBy { get; set; }
public virtual DateTime? Deleted { get; set; }
public virtual int? DeletedBy { get; set; }
public virtual int EventType { get; set; }
public virtual int ContentType { get; set; }
public virtual bool? Hidden { get; set; }
public virtual int? ParentMessageTemplateId { get; set; }
public virtual string InclusionTags { get; set; }
public virtual string ExclusionTags { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
[DataMember(Order=2)]
public virtual int? Take { get; set; }
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<T>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<T>
{
public QueryResponse()
{
Results = new List<T>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<T> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FindMessageTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
<Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
<Take xmlns="http://schemas.servicestack.net/types">0</Take>
<OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
<OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
<Include xmlns="http://schemas.servicestack.net/types">String</Include>
<Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</FindMessageTemplate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfMessageTemplateInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
<d2p1:MessageTemplateInstance>
<d2p1:Body>String</d2p1:Body>
<d2p1:ContentType>0</d2p1:ContentType>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:CreatedBy>0</d2p1:CreatedBy>
<d2p1:Deleted>0001-01-01T00:00:00</d2p1:Deleted>
<d2p1:DeletedBy>0</d2p1:DeletedBy>
<d2p1:EventType>0</d2p1:EventType>
<d2p1:ExclusionTags>String</d2p1:ExclusionTags>
<d2p1:Hidden>false</d2p1:Hidden>
<d2p1:InclusionTags>String</d2p1:InclusionTags>
<d2p1:MessageTemplateId>0</d2p1:MessageTemplateId>
<d2p1:Modified>0001-01-01T00:00:00</d2p1:Modified>
<d2p1:ModifiedBy>0</d2p1:ModifiedBy>
<d2p1:Name>String</d2p1:Name>
<d2p1:ParentMessageTemplateId>0</d2p1:ParentMessageTemplateId>
<d2p1:ReportId>0</d2p1:ReportId>
<d2p1:Subject>String</d2p1:Subject>
<d2p1:TemplateType>0</d2p1:TemplateType>
</d2p1:MessageTemplateInstance>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfMessageTemplateInstancePEZRWkv_P>