| GET | /rating/ | Get Ratings | Get Ratings. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class BaseModel
{
}
public partial class Rating
: BaseModel
{
public virtual Guid? ReviewId { get; set; }
public virtual Review Review { get; set; }
[Required]
public virtual Guid CompanyId { get; set; }
[Required]
public virtual int BookingId { get; set; }
[Required]
public virtual int RatingScore { get; set; }
[Required]
public virtual int Status { get; set; }
[Required]
public virtual DateTime Created { get; set; }
[Required]
public virtual DateTime Updated { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
}
public partial class Review
: BaseModel
{
public virtual Guid ReviewId { get; set; }
[Required]
public virtual Guid CompanyId { get; set; }
[Required]
public virtual string Title { get; set; }
[Required]
public virtual string Description { get; set; }
[Required]
public virtual string Author { get; set; }
[Required]
public virtual int Status { get; set; }
[Required]
public virtual DateTime Created { get; set; }
[Required]
public virtual DateTime Updated { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
public virtual string ReviewAnswer { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
public partial class CompanyRatingResponse
{
///<summary>
///
///</summary>
[ApiMember(Description="")]
public virtual Guid CompanyId { get; set; }
///<summary>
///Id of the booking
///</summary>
[ApiMember(Description="Id of the booking")]
public virtual int BookingId { get; set; }
///<summary>
///The status of the rating, 1 = Active
///</summary>
[ApiMember(Description="The status of the rating, 1 = Active")]
public virtual int Status { get; set; }
///<summary>
///The rating score
///</summary>
[ApiMember(Description="The rating score")]
public virtual int RatingScore { get; set; }
///<summary>
///The review if any exists to the rating
///</summary>
[ApiMember(Description="The review if any exists to the rating")]
public virtual RatingReviewResponse Review { get; set; }
public virtual DateTime CreatedDate { get; set; }
public virtual DateTime UpdatedDate { get; set; }
}
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
public partial class RatingQuery
: QueryDb<Rating, CompanyRatingResponse>, ICompany
{
///<summary>
///
///</summary>
[ApiMember(Description="")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///Id of the booking
///</summary>
[DataMember(Name="BookedEventId")]
[ApiMember(Description="Id of the booking")]
public virtual int? BookingId { 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.")]
public virtual bool? Active { 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")]
public virtual bool IncludeRatingReviews { 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")]
public virtual DateTime? CreatedFrom { 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")]
public virtual DateTime? CreatedTo { get; set; }
}
public partial class RatingReviewResponse
{
///<summary>
///The title for the review
///</summary>
[ApiMember(Description="The title for the review")]
public virtual string Title { get; set; }
///<summary>
///The description for the review
///</summary>
[ApiMember(Description="The description for the review")]
public virtual string Description { get; set; }
///<summary>
///The rating score
///</summary>
[ApiMember(Description="The rating score")]
public virtual int RatingScore { get; set; }
///<summary>
///The review author
///</summary>
[ApiMember(Description="The review author")]
public virtual string Author { get; set; }
///<summary>
///The created date
///</summary>
[ApiMember(Description="The created date")]
public virtual DateTime Created { get; set; }
///<summary>
///The review answer from the company
///</summary>
[ApiMember(Description="The review answer from the company")]
public virtual string ReviewAnswer { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
public QueryBase()
{
Meta = new Dictionary<string, string>{};
}
///<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)]
public virtual int? Skip { 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)]
public virtual int? Take { 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)]
public virtual string OrderBy { 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)]
public virtual string OrderByDesc { 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)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<AccessKeyTypeResponse>
{
public QueryResponse()
{
Results = new List<AccessKeyTypeResponse>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<AccessKeyTypeResponse> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { 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
}
}
}