| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /rating/reviews | Get Reviews | Get Reviews. |
|---|
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="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
public static class ReviewQuery extends QueryDb<Review, RatingReviewResponse> implements ICompany
{
/**
*
*/
@ApiMember(Description="")
public UUID CompanyId = null;
/**
*
*/
@ApiMember(Description="")
public UUID Id = null;
/**
* If you want to collect only active reviews
*/
@ApiMember(Description="If you want to collect only active reviews")
public Boolean Active = null;
public UUID getCompanyId() { return CompanyId; }
public ReviewQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public UUID getId() { return Id; }
public ReviewQuery setId(UUID value) { this.Id = value; return this; }
public Boolean isActive() { return Active; }
public ReviewQuery setActive(Boolean value) { this.Active = 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 Review extends BaseModel
{
public UUID ReviewId = null;
@Required()
public UUID CompanyId = null;
@Required()
public String Title = null;
@Required()
public String Description = null;
@Required()
public String Author = null;
@Required()
public Integer Status = null;
@Required()
public Date Created = null;
@Required()
public Date Updated = null;
public Date ModifiedDate = null;
public String ReviewAnswer = null;
public UUID getReviewId() { return ReviewId; }
public Review setReviewId(UUID value) { this.ReviewId = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public Review setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getTitle() { return Title; }
public Review setTitle(String value) { this.Title = value; return this; }
public String getDescription() { return Description; }
public Review setDescription(String value) { this.Description = value; return this; }
public String getAuthor() { return Author; }
public Review setAuthor(String value) { this.Author = value; return this; }
public Integer getStatus() { return Status; }
public Review setStatus(Integer value) { this.Status = value; return this; }
public Date getCreated() { return Created; }
public Review setCreated(Date value) { this.Created = value; return this; }
public Date getUpdated() { return Updated; }
public Review setUpdated(Date value) { this.Updated = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Review setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getReviewAnswer() { return ReviewAnswer; }
public Review setReviewAnswer(String value) { this.ReviewAnswer = value; return this; }
}
public static class BaseModel
{
}
public static class RatingReviewResponse
{
/**
* The title for the review
*/
@ApiMember(Description="The title for the review")
public String Title = null;
/**
* The description for the review
*/
@ApiMember(Description="The description for the review")
public String Description = null;
/**
* The rating score
*/
@ApiMember(Description="The rating score")
public Integer RatingScore = null;
/**
* The review author
*/
@ApiMember(Description="The review author")
public String Author = null;
/**
* The created date
*/
@ApiMember(Description="The created date")
public Date Created = null;
/**
* The review answer from the company
*/
@ApiMember(Description="The review answer from the company")
public String ReviewAnswer = null;
public String getTitle() { return Title; }
public RatingReviewResponse setTitle(String value) { this.Title = value; return this; }
public String getDescription() { return Description; }
public RatingReviewResponse setDescription(String value) { this.Description = value; return this; }
public Integer getRatingScore() { return RatingScore; }
public RatingReviewResponse setRatingScore(Integer value) { this.RatingScore = value; return this; }
public String getAuthor() { return Author; }
public RatingReviewResponse setAuthor(String value) { this.Author = value; return this; }
public Date getCreated() { return Created; }
public RatingReviewResponse setCreated(Date value) { this.Created = value; return this; }
public String getReviewAnswer() { return ReviewAnswer; }
public RatingReviewResponse setReviewAnswer(String value) { this.ReviewAnswer = 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; }
}
}
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.
GET /rating/reviews HTTP/1.1 Host: api.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Title":"String","Description":"String","RatingScore":0,"Author":"String","ReviewAnswer":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}