| Required role: | superadmin |
| GET | /superadmin/company/{CompanyId}/comments | Get companies comments. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
@ApiResponse(Description="", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
public static class CommentsSuperAdminUserQuery extends QueryDb<CompanyComment, CompanyCommentsResponse>
{
/**
* Enter the companyId for the customer
*/
@ApiMember(Description="Enter the companyId for the customer", IsRequired=true, ParameterType="query")
public UUID CompanyId = null;
@ApiMember()
public Integer CommentsTypeId = null;
public UUID getCompanyId() { return CompanyId; }
public CommentsSuperAdminUserQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getCommentsTypeId() { return CommentsTypeId; }
public CommentsSuperAdminUserQuery setCommentsTypeId(Integer value) { this.CommentsTypeId = value; return this; }
}
public static class QueryDb<From, Into> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
@DataMember(Order=1)
public Integer Skip = null;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
@DataMember(Order=2)
public Integer Take = null;
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
@DataMember(Order=3)
public String OrderBy = null;
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
@DataMember(Order=4)
public String OrderByDesc = null;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
@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 CompanyComment extends BaseModel
{
public CommentsType CommentsType = null;
@Required()
public UUID CompanyId = null;
public Integer Id = null;
public Integer CommentsTypeId = null;
public String Comments = null;
public String CreatedBy = null;
@Required()
public Date Created = null;
@Required()
public Date Updated = null;
public Date ModifiedDate = null;
public CommentsType getCommentsType() { return CommentsType; }
public CompanyComment setCommentsType(CommentsType value) { this.CommentsType = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public CompanyComment setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public CompanyComment setId(Integer value) { this.Id = value; return this; }
public Integer getCommentsTypeId() { return CommentsTypeId; }
public CompanyComment setCommentsTypeId(Integer value) { this.CommentsTypeId = value; return this; }
public String getComments() { return Comments; }
public CompanyComment setComments(String value) { this.Comments = value; return this; }
public String getCreatedBy() { return CreatedBy; }
public CompanyComment setCreatedBy(String value) { this.CreatedBy = value; return this; }
public Date getCreated() { return Created; }
public CompanyComment setCreated(Date value) { this.Created = value; return this; }
public Date getUpdated() { return Updated; }
public CompanyComment setUpdated(Date value) { this.Updated = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public CompanyComment setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
}
public static class BaseModel
{
}
public static class CommentsType extends BaseModel
{
public Integer Id = null;
public String Name = null;
public String Description = null;
public Date ModifiedDate = null;
public Integer getId() { return Id; }
public CommentsType setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public CommentsType setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public CommentsType setDescription(String value) { this.Description = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public CommentsType setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
}
public static class CompanyCommentsResponse
{
@ApiMember()
public UUID CompanyId = null;
@ApiMember()
public Integer Id = null;
@ApiMember(IsRequired=true)
public String Comment = null;
@ApiMember(IsRequired=true)
public CommentsType CommentTypeId = null;
@ApiMember(IsRequired=true)
public CommentsTypeResponse CommentType = null;
/**
* The updated date
*/
@ApiMember(Description="The updated date")
public Date Updated = null;
/**
* The created date
*/
@ApiMember(Description="The created date")
public Date Created = null;
/**
* The created by
*/
@ApiMember(Description="The created by")
public String CreatedBy = null;
public UUID getCompanyId() { return CompanyId; }
public CompanyCommentsResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public CompanyCommentsResponse setId(Integer value) { this.Id = value; return this; }
public String getComment() { return Comment; }
public CompanyCommentsResponse setComment(String value) { this.Comment = value; return this; }
public CommentsType getCommentTypeId() { return CommentTypeId; }
public CompanyCommentsResponse setCommentTypeId(CommentsType value) { this.CommentTypeId = value; return this; }
public CommentsTypeResponse getCommentType() { return CommentType; }
public CompanyCommentsResponse setCommentType(CommentsTypeResponse value) { this.CommentType = value; return this; }
public Date getUpdated() { return Updated; }
public CompanyCommentsResponse setUpdated(Date value) { this.Updated = value; return this; }
public Date getCreated() { return Created; }
public CompanyCommentsResponse setCreated(Date value) { this.Created = value; return this; }
public String getCreatedBy() { return CreatedBy; }
public CompanyCommentsResponse setCreatedBy(String value) { this.CreatedBy = value; return this; }
}
public static enum CommentsType
{
NormalComment(1),
CallBackPhoneComment(2),
CallBackEmailComment(3),
CallBackMeetingBookedComment(4),
CallBackNotInterestedComment(5);
private final int value;
CommentsType(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class CommentsTypeResponse
{
public Integer Id = null;
public String Name = null;
public String Description = null;
public Integer getId() { return Id; }
public CommentsTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public CommentsTypeResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public CommentsTypeResponse setDescription(String value) { this.Description = value; return this; }
}
@DataContract
public static class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<AccessKeyTypeResponse> 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<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AccessKeyTypeResponse
{
public Integer Id = null;
public String KeyType = null;
public String Description = null;
public Integer getId() { return Id; }
public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getKeyType() { return KeyType; }
public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
public String getDescription() { return Description; }
public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
}
}
Java CommentsSuperAdminUserQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /superadmin/company/{CompanyId}/comments HTTP/1.1
Host: testapi.bokamera.se
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Comment":"String","CommentTypeId":"NormalComment","CommentType":{"Id":0,"Name":"String","Description":"String"},"CreatedBy":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}