Required role: | API |
All Verbs | /api/Query/Template |
---|
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="Template")
public static class FindTemplate extends QueryDb<TemplateInstance>
{
}
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 TemplateInstance
{
public Integer TemplateId = null;
public String Description = null;
public String TemplateHtml = null;
public Boolean IsEnabled = null;
public Boolean IsSystem = null;
public Integer TemplateType = null;
public Integer EventType = null;
public Boolean Deleted = null;
public Boolean Demo = null;
public Integer getTemplateId() { return TemplateId; }
public TemplateInstance setTemplateId(Integer value) { this.TemplateId = value; return this; }
public String getDescription() { return Description; }
public TemplateInstance setDescription(String value) { this.Description = value; return this; }
public String getTemplateHtml() { return TemplateHtml; }
public TemplateInstance setTemplateHtml(String value) { this.TemplateHtml = value; return this; }
public Boolean getIsEnabled() { return IsEnabled; }
public TemplateInstance setIsEnabled(Boolean value) { this.IsEnabled = value; return this; }
public Boolean getIsSystem() { return IsSystem; }
public TemplateInstance setIsSystem(Boolean value) { this.IsSystem = value; return this; }
public Integer getTemplateType() { return TemplateType; }
public TemplateInstance setTemplateType(Integer value) { this.TemplateType = value; return this; }
public Integer getEventType() { return EventType; }
public TemplateInstance setEventType(Integer value) { this.EventType = value; return this; }
public Boolean isDeleted() { return Deleted; }
public TemplateInstance setDeleted(Boolean value) { this.Deleted = value; return this; }
public Boolean isDemo() { return Demo; }
public TemplateInstance setDemo(Boolean value) { this.Demo = 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/Template HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/csv
Content-Type: text/csv
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/csv Content-Length: length {"Offset":0,"Total":0,"Results":[{"TemplateId":0,"Description":"String","TemplateHtml":"String","IsEnabled":false,"IsSystem":false,"TemplateType":0,"EventType":0,"Deleted":false,"Demo":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}