| Required role: | API |
| 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.*;
public class dtos
{
@AutoQueryViewer(Description="", IconUrl="octicon:database", Title="MessageTemplate")
public static class FindMessageTemplate extends QueryDb<MessageTemplateInstance>
{
}
public static class QueryDb<T> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
@DataMember(Order=1)
public Integer Skip = null;
@DataMember(Order=2)
public Integer Take = null;
@DataMember(Order=3)
public String OrderBy = null;
@DataMember(Order=4)
public String OrderByDesc = null;
@DataMember(Order=5)
public String Include = null;
@DataMember(Order=6)
public String Fields = null;
@DataMember(Order=7)
public HashMap<String,String> Meta = null;
public Integer getSkip() { return Skip; }
public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
public Integer getTake() { return Take; }
public QueryBase setTake(Integer value) { this.Take = value; return this; }
public String getOrderBy() { return OrderBy; }
public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
public String getOrderByDesc() { return OrderByDesc; }
public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
public String getInclude() { return Include; }
public QueryBase setInclude(String value) { this.Include = value; return this; }
public String getFields() { return Fields; }
public QueryBase setFields(String value) { this.Fields = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
}
public static class MessageTemplateInstance
{
public Integer MessageTemplateId = null;
public String Name = null;
public String Subject = null;
public String Body = null;
public Integer ReportId = null;
public Integer TemplateType = null;
public Date Created = null;
public Integer CreatedBy = null;
public Date Modified = null;
public Integer ModifiedBy = null;
public Date Deleted = null;
public Integer DeletedBy = null;
public Integer EventType = null;
public Integer ContentType = null;
public Boolean Hidden = null;
public Integer ParentMessageTemplateId = null;
public String InclusionTags = null;
public String ExclusionTags = null;
public Integer getMessageTemplateId() { return MessageTemplateId; }
public MessageTemplateInstance setMessageTemplateId(Integer value) { this.MessageTemplateId = value; return this; }
public String getName() { return Name; }
public MessageTemplateInstance setName(String value) { this.Name = value; return this; }
public String getSubject() { return Subject; }
public MessageTemplateInstance setSubject(String value) { this.Subject = value; return this; }
public String getBody() { return Body; }
public MessageTemplateInstance setBody(String value) { this.Body = value; return this; }
public Integer getReportId() { return ReportId; }
public MessageTemplateInstance setReportId(Integer value) { this.ReportId = value; return this; }
public Integer getTemplateType() { return TemplateType; }
public MessageTemplateInstance setTemplateType(Integer value) { this.TemplateType = value; return this; }
public Date getCreated() { return Created; }
public MessageTemplateInstance setCreated(Date value) { this.Created = value; return this; }
public Integer getCreatedBy() { return CreatedBy; }
public MessageTemplateInstance setCreatedBy(Integer value) { this.CreatedBy = value; return this; }
public Date getModified() { return Modified; }
public MessageTemplateInstance setModified(Date value) { this.Modified = value; return this; }
public Integer getModifiedBy() { return ModifiedBy; }
public MessageTemplateInstance setModifiedBy(Integer value) { this.ModifiedBy = value; return this; }
public Date getDeleted() { return Deleted; }
public MessageTemplateInstance setDeleted(Date value) { this.Deleted = value; return this; }
public Integer getDeletedBy() { return DeletedBy; }
public MessageTemplateInstance setDeletedBy(Integer value) { this.DeletedBy = value; return this; }
public Integer getEventType() { return EventType; }
public MessageTemplateInstance setEventType(Integer value) { this.EventType = value; return this; }
public Integer getContentType() { return ContentType; }
public MessageTemplateInstance setContentType(Integer value) { this.ContentType = value; return this; }
public Boolean isHidden() { return Hidden; }
public MessageTemplateInstance setHidden(Boolean value) { this.Hidden = value; return this; }
public Integer getParentMessageTemplateId() { return ParentMessageTemplateId; }
public MessageTemplateInstance setParentMessageTemplateId(Integer value) { this.ParentMessageTemplateId = value; return this; }
public String getInclusionTags() { return InclusionTags; }
public MessageTemplateInstance setInclusionTags(String value) { this.InclusionTags = value; return this; }
public String getExclusionTags() { return ExclusionTags; }
public MessageTemplateInstance setExclusionTags(String value) { this.ExclusionTags = value; return this; }
}
@DataContract
public static class QueryResponse<T>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<T> Results = null;
@DataMember(Order=4)
public HashMap<String,String> Meta = null;
@DataMember(Order=5)
public ResponseStatus ResponseStatus = null;
public Integer getOffset() { return Offset; }
public QueryResponse<T> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<T> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<T> getResults() { return Results; }
public QueryResponse<T> setResults(ArrayList<T> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<T> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
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
}
}
}