| GET | /rating/ | Get Ratings | Get Ratings. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class RatingQuery : QueryDb<Rating, CompanyRatingResponse>(), ICompany
{
/**
*
*/
@ApiMember(Description="")
var CompanyId:UUID? = null
/**
* Id of the booking
*/
@DataMember(Name="BookedEventId")
@SerializedName("BookedEventId")
@ApiMember(Description="Id of the booking")
var BookingId:Int? = null
/**
* If you want to collect only active ratings. Ratings are only active after one has past since creation date.
*/
@ApiMember(Description="If you want to collect only active ratings. Ratings are only active after one has past since creation date.")
var Active:Boolean? = null
/**
* If you want to include the rating reviews
*/
@ApiMember(DataType="boolean", Description="If you want to include the rating reviews", ParameterType="query")
var IncludeRatingReviews:Boolean? = null
/**
* Start of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
*/
@ApiMember(DataType="dateTime", Description="Start of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339", ParameterType="query")
var CreatedFrom:Date? = null
/**
* End of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
*/
@ApiMember(DataType="dateTime", Description="End of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339", ParameterType="query")
var CreatedTo:Date? = null
}
open class QueryDb<From, Into> : QueryBase()
{
}
@DataContract
open 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)
var Skip:Int? = 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)
var Take:Int? = 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)
var OrderBy:String? = 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)
var OrderByDesc:String? = 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)
var Include:String? = null
@DataMember(Order=6)
var Fields:String? = null
@DataMember(Order=7)
var Meta:HashMap<String,String> = HashMap<String,String>()
}
open class Rating : BaseModel()
{
var ReviewId:UUID? = null
var Review:Review? = null
@Required()
var CompanyId:UUID? = null
@Required()
var BookingId:Int? = null
@Required()
var RatingScore:Int? = null
@Required()
var Status:Int? = null
@Required()
var Created:Date? = null
@Required()
var Updated:Date? = null
var ModifiedDate:Date? = null
}
open class BaseModel
{
}
open class Review : BaseModel()
{
var ReviewId:UUID? = null
@Required()
var CompanyId:UUID? = null
@Required()
var Title:String? = null
@Required()
var Description:String? = null
@Required()
var Author:String? = null
@Required()
var Status:Int? = null
@Required()
var Created:Date? = null
@Required()
var Updated:Date? = null
var ModifiedDate:Date? = null
var ReviewAnswer:String? = null
}
open class CompanyRatingResponse
{
/**
*
*/
@ApiMember(Description="")
var CompanyId:UUID? = null
/**
* Id of the booking
*/
@ApiMember(Description="Id of the booking")
var BookingId:Int? = null
/**
* The status of the rating, 1 = Active
*/
@ApiMember(Description="The status of the rating, 1 = Active")
var Status:Int? = null
/**
* The rating score
*/
@ApiMember(Description="The rating score")
var RatingScore:Int? = null
/**
* The review if any exists to the rating
*/
@ApiMember(Description="The review if any exists to the rating")
var Review:RatingReviewResponse? = null
var CreatedDate:Date? = null
var UpdatedDate:Date? = null
}
open class RatingReviewResponse
{
/**
* The title for the review
*/
@ApiMember(Description="The title for the review")
var Title:String? = null
/**
* The description for the review
*/
@ApiMember(Description="The description for the review")
var Description:String? = null
/**
* The rating score
*/
@ApiMember(Description="The rating score")
var RatingScore:Int? = null
/**
* The review author
*/
@ApiMember(Description="The review author")
var Author:String? = null
/**
* The created date
*/
@ApiMember(Description="The created date")
var Created:Date? = null
/**
* The review answer from the company
*/
@ApiMember(Description="The review answer from the company")
var ReviewAnswer:String? = null
}
@DataContract
open class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
var Offset:Int? = null
@DataMember(Order=2)
var Total:Int? = null
@DataMember(Order=3)
var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()
@DataMember(Order=4)
var Meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
var Id:Int? = null
var KeyType:String? = null
var Description:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /rating/ HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"BookingId":0,"Status":0,"RatingScore":0,"Review":{"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"}}}