BokaMera.API.Host

<back to all web services

RatingQuery

The following routes are available for this service:
GET/rating/Get RatingsGet 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
}

Kotlin RatingQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCompanyRatingResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:CompanyRatingResponse>
      <d2p1:BookingId>0</d2p1:BookingId>
      <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:RatingScore>0</d2p1:RatingScore>
      <d2p1:Review>
        <d2p1:Author>String</d2p1:Author>
        <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:RatingScore>0</d2p1:RatingScore>
        <d2p1:ReviewAnswer>String</d2p1:ReviewAnswer>
        <d2p1:Title>String</d2p1:Title>
      </d2p1:Review>
      <d2p1:Status>0</d2p1:Status>
      <d2p1:UpdatedDate>0001-01-01T00:00:00</d2p1:UpdatedDate>
    </d2p1:CompanyRatingResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfCompanyRatingResponseWg5EthtI>