| Required role: | API |
| All Verbs | /api/Query/Message |
|---|
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="Message")
public static class FindMessage extends QueryDb<MessageInstance>
{
}
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 MessageInstance
{
public Integer MessageId = null;
public Date DueDate = null;
public Date SentDate = null;
public Boolean Processed = null;
public Integer Failures = null;
public Integer InstanceId = null;
public String MessageSid = null;
public MessageTemplateInstance MessageTemplate = null;
@References(MessageTemplateInstance.class)
public Integer MessageTemplateId = null;
public Date OpenedDate = null;
public Date BouncedDate = null;
public Date DeliveredDate = null;
public Date UnsubscribedDate = null;
public Date SpamReportDate = null;
public UserInstance User = null;
@References(UserInstance.class)
public Integer UserId = null;
public Integer InstanceType = null;
public Integer getMessageId() { return MessageId; }
public MessageInstance setMessageId(Integer value) { this.MessageId = value; return this; }
public Date getDueDate() { return DueDate; }
public MessageInstance setDueDate(Date value) { this.DueDate = value; return this; }
public Date getSentDate() { return SentDate; }
public MessageInstance setSentDate(Date value) { this.SentDate = value; return this; }
public Boolean isProcessed() { return Processed; }
public MessageInstance setProcessed(Boolean value) { this.Processed = value; return this; }
public Integer getFailures() { return Failures; }
public MessageInstance setFailures(Integer value) { this.Failures = value; return this; }
public Integer getInstanceId() { return InstanceId; }
public MessageInstance setInstanceId(Integer value) { this.InstanceId = value; return this; }
public String getMessageSid() { return MessageSid; }
public MessageInstance setMessageSid(String value) { this.MessageSid = value; return this; }
public MessageTemplateInstance getMessageTemplate() { return MessageTemplate; }
public MessageInstance setMessageTemplate(MessageTemplateInstance value) { this.MessageTemplate = value; return this; }
public Integer getMessageTemplateId() { return MessageTemplateId; }
public MessageInstance setMessageTemplateId(Integer value) { this.MessageTemplateId = value; return this; }
public Date getOpenedDate() { return OpenedDate; }
public MessageInstance setOpenedDate(Date value) { this.OpenedDate = value; return this; }
public Date getBouncedDate() { return BouncedDate; }
public MessageInstance setBouncedDate(Date value) { this.BouncedDate = value; return this; }
public Date getDeliveredDate() { return DeliveredDate; }
public MessageInstance setDeliveredDate(Date value) { this.DeliveredDate = value; return this; }
public Date getUnsubscribedDate() { return UnsubscribedDate; }
public MessageInstance setUnsubscribedDate(Date value) { this.UnsubscribedDate = value; return this; }
public Date getSpamReportDate() { return SpamReportDate; }
public MessageInstance setSpamReportDate(Date value) { this.SpamReportDate = value; return this; }
public UserInstance getUser() { return User; }
public MessageInstance setUser(UserInstance value) { this.User = value; return this; }
public Integer getUserId() { return UserId; }
public MessageInstance setUserId(Integer value) { this.UserId = value; return this; }
public Integer getInstanceType() { return InstanceType; }
public MessageInstance setInstanceType(Integer value) { this.InstanceType = 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; }
}
public static class UserInstance
{
public Integer UserId = null;
public String UserName = null;
public String Name = null;
public String Email = null;
public String MobilePhone = null;
public Boolean Enabled = null;
public Date LastLogin = null;
public Date Created = null;
public Boolean Training = null;
public Boolean Deleted = null;
public Integer CoursesCompleted = null;
public Boolean DisplayHomeNotification = null;
public Boolean TwoFactorEnabled = null;
public Boolean EmailConfirmed = null;
public Boolean MobilePhoneConfirmed = null;
public Boolean Notifications = null;
public Date ChangePassword = null;
public Date Activated = null;
public Integer getUserId() { return UserId; }
public UserInstance setUserId(Integer value) { this.UserId = value; return this; }
public String getUserName() { return UserName; }
public UserInstance setUserName(String value) { this.UserName = value; return this; }
public String getName() { return Name; }
public UserInstance setName(String value) { this.Name = value; return this; }
public String getEmail() { return Email; }
public UserInstance setEmail(String value) { this.Email = value; return this; }
public String getMobilePhone() { return MobilePhone; }
public UserInstance setMobilePhone(String value) { this.MobilePhone = value; return this; }
public Boolean isEnabled() { return Enabled; }
public UserInstance setEnabled(Boolean value) { this.Enabled = value; return this; }
public Date getLastLogin() { return LastLogin; }
public UserInstance setLastLogin(Date value) { this.LastLogin = value; return this; }
public Date getCreated() { return Created; }
public UserInstance setCreated(Date value) { this.Created = value; return this; }
public Boolean isTraining() { return Training; }
public UserInstance setTraining(Boolean value) { this.Training = value; return this; }
public Boolean isDeleted() { return Deleted; }
public UserInstance setDeleted(Boolean value) { this.Deleted = value; return this; }
public Integer getCoursesCompleted() { return CoursesCompleted; }
public UserInstance setCoursesCompleted(Integer value) { this.CoursesCompleted = value; return this; }
public Boolean isDisplayHomeNotification() { return DisplayHomeNotification; }
public UserInstance setDisplayHomeNotification(Boolean value) { this.DisplayHomeNotification = value; return this; }
public Boolean isTwoFactorEnabled() { return TwoFactorEnabled; }
public UserInstance setTwoFactorEnabled(Boolean value) { this.TwoFactorEnabled = value; return this; }
public Boolean isEmailConfirmed() { return EmailConfirmed; }
public UserInstance setEmailConfirmed(Boolean value) { this.EmailConfirmed = value; return this; }
public Boolean isMobilePhoneConfirmed() { return MobilePhoneConfirmed; }
public UserInstance setMobilePhoneConfirmed(Boolean value) { this.MobilePhoneConfirmed = value; return this; }
public Boolean isNotifications() { return Notifications; }
public UserInstance setNotifications(Boolean value) { this.Notifications = value; return this; }
public Date getChangePassword() { return ChangePassword; }
public UserInstance setChangePassword(Date value) { this.ChangePassword = value; return this; }
public Date getActivated() { return Activated; }
public UserInstance setActivated(Date value) { this.Activated = 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/Message 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":[{"MessageId":0,"DueDate":"0001-01-01T00:00:00.0000000","SentDate":"0001-01-01T00:00:00.0000000","Processed":false,"Failures":0,"InstanceId":0,"MessageSid":"String","MessageTemplate":{"MessageTemplateId":0,"Name":"String","Subject":"String","Body":"String","ReportId":0,"TemplateType":0,"Created":"0001-01-01T00:00:00.0000000","CreatedBy":0,"Modified":"0001-01-01T00:00:00.0000000","ModifiedBy":0,"Deleted":"0001-01-01T00:00:00.0000000","DeletedBy":0,"EventType":0,"ContentType":0,"Hidden":false,"ParentMessageTemplateId":0,"InclusionTags":"String","ExclusionTags":"String"},"MessageTemplateId":0,"OpenedDate":"0001-01-01T00:00:00.0000000","BouncedDate":"0001-01-01T00:00:00.0000000","DeliveredDate":"0001-01-01T00:00:00.0000000","UnsubscribedDate":"0001-01-01T00:00:00.0000000","SpamReportDate":"0001-01-01T00:00:00.0000000","User":{"UserId":0,"UserName":"String","Name":"String","Email":"String","MobilePhone":"String","Enabled":false,"LastLogin":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Training":false,"Deleted":false,"CoursesCompleted":0,"DisplayHomeNotification":false,"TwoFactorEnabled":false,"EmailConfirmed":false,"MobilePhoneConfirmed":false,"Notifications":false,"ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"},"UserId":0,"InstanceType":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}