| GET | /rating/ | Get Ratings | Get Ratings. |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type RatingReviewResponse() =
///<summary>
///The title for the review
///</summary>
[<ApiMember(Description="The title for the review")>]
member val Title:String = null with get,set
///<summary>
///The description for the review
///</summary>
[<ApiMember(Description="The description for the review")>]
member val Description:String = null with get,set
///<summary>
///The rating score
///</summary>
[<ApiMember(Description="The rating score")>]
member val RatingScore:Int32 = new Int32() with get,set
///<summary>
///The review author
///</summary>
[<ApiMember(Description="The review author")>]
member val Author:String = null with get,set
///<summary>
///The created date
///</summary>
[<ApiMember(Description="The created date")>]
member val Created:DateTime = new DateTime() with get,set
///<summary>
///The review answer from the company
///</summary>
[<ApiMember(Description="The review answer from the company")>]
member val ReviewAnswer:String = null with get,set
[<AllowNullLiteral>]
type CompanyRatingResponse() =
///<summary>
///
///</summary>
[<ApiMember(Description="")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///Id of the booking
///</summary>
[<ApiMember(Description="Id of the booking")>]
member val BookingId:Int32 = new Int32() with get,set
///<summary>
///The status of the rating, 1 = Active
///</summary>
[<ApiMember(Description="The status of the rating, 1 = Active")>]
member val Status:Int32 = new Int32() with get,set
///<summary>
///The rating score
///</summary>
[<ApiMember(Description="The rating score")>]
member val RatingScore:Int32 = new Int32() with get,set
///<summary>
///The review if any exists to the rating
///</summary>
[<ApiMember(Description="The review if any exists to the rating")>]
member val Review:RatingReviewResponse = null with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val UpdatedDate:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type Review() =
inherit BaseModel()
member val ReviewId:Guid = new Guid() with get,set
[<Required>]
member val CompanyId:Guid = new Guid() with get,set
[<Required>]
member val Title:String = null with get,set
[<Required>]
member val Description:String = null with get,set
[<Required>]
member val Author:String = null with get,set
[<Required>]
member val Status:Int32 = new Int32() with get,set
[<Required>]
member val Created:DateTime = new DateTime() with get,set
[<Required>]
member val Updated:DateTime = new DateTime() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
member val ReviewAnswer:String = null with get,set
[<AllowNullLiteral>]
type Rating() =
inherit BaseModel()
member val ReviewId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val Review:Review = null with get,set
[<Required>]
member val CompanyId:Guid = new Guid() with get,set
[<Required>]
member val BookingId:Int32 = new Int32() with get,set
[<Required>]
member val RatingScore:Int32 = new Int32() with get,set
[<Required>]
member val Status:Int32 = new Int32() with get,set
[<Required>]
member val Created:DateTime = new DateTime() with get,set
[<Required>]
member val Updated:DateTime = new DateTime() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<AllowNullLiteral>]
type RatingQuery() =
inherit QueryDb<Rating, CompanyRatingResponse>()
///<summary>
///
///</summary>
[<ApiMember(Description="")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Id of the booking
///</summary>
[<DataMember(Name="BookedEventId")>]
[<ApiMember(Description="Id of the booking")>]
member val BookingId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///If you want to collect only active ratings. Ratings are only active after one has past since creation date.
///</summary>
[<ApiMember(Description="If you want to collect only active ratings. Ratings are only active after one has past since creation date.")>]
member val Active:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///If you want to include the rating reviews
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the rating reviews", ParameterType="query")>]
member val IncludeRatingReviews:Boolean = new Boolean() with get,set
///<summary>
///Start of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
///</summary>
[<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")>]
member val CreatedFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///End of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
///</summary>
[<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")>]
member val CreatedTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
///<summary>
///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>
///</summary>
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
///<summary>
///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>
///</summary>
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<AccessKeyTypeResponse>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = new ResizeArray<AccessKeyTypeResponse>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /rating/ HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}