BokaMera.API.Host

<back to all web services

ReviewQuery

import java.math.*
import java.util.*
import java.io.InputStream
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)
@ValidateRequest(Validator="IsAuthenticated")
open class ReviewQuery : QueryDb<Review, RatingReviewResponse>(), ICompany
{
    /**
    * 
    */
    @ApiMember(Description="")
    override var CompanyId:UUID? = null

    /**
    * 
    */
    @ApiMember(Description="")
    open var Id:UUID? = null

    /**
    * If you want to collect only active reviews
    */
    @ApiMember(Description="If you want to collect only active reviews")
    open var Active:Boolean? = null
}

open class QueryDb<From, Into> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    open var Skip:Int? = null

    @DataMember(Order=2)
    open var Take:Int? = null

    @DataMember(Order=3)
    open var OrderBy:String? = null

    @DataMember(Order=4)
    open var OrderByDesc:String? = null

    @DataMember(Order=5)
    open var Include:String? = null

    @DataMember(Order=6)
    open var Fields:String? = null

    @DataMember(Order=7)
    open var Meta:HashMap<String,String>? = null
}

open class Review : BaseModel()
{
    open var ReviewId:UUID? = null
    @Required()
    open var CompanyId:UUID? = null

    @Required()
    open var Title:String? = null

    @Required()
    open var Description:String? = null

    @Required()
    open var Author:String? = null

    @Required()
    open var Status:Int? = null

    @Required()
    open var Created:Date? = null

    @Required()
    open var Updated:Date? = null

    open var ModifiedDate:Date? = null
    open var ReviewAnswer:String? = null
}

open class BaseModel
{
}

open class RatingReviewResponse
{
    /**
    * The title for the review
    */
    @ApiMember(Description="The title for the review")
    open var Title:String? = null

    /**
    * The description for the review
    */
    @ApiMember(Description="The description for the review")
    open var Description:String? = null

    /**
    * The rating score
    */
    @ApiMember(Description="The rating score")
    open var RatingScore:Int? = null

    /**
    * The review author
    */
    @ApiMember(Description="The review author")
    open var Author:String? = null

    /**
    * The created date
    */
    @ApiMember(Description="The created date")
    open var Created:Date? = null

    /**
    * The review answer from the company
    */
    @ApiMember(Description="The review answer from the company")
    open var ReviewAnswer:String? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    open var Offset:Int? = null

    @DataMember(Order=2)
    open var Total:Int? = null

    @DataMember(Order=3)
    open var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()

    @DataMember(Order=4)
    open var Meta:HashMap<String,String>? = null

    @DataMember(Order=5)
    open var ResponseStatus:ResponseStatus? = null
}

open class AccessKeyTypeResponse
{
    open var Id:Int? = null
    open var KeyType:String? = null
    open var Description:String? = null
}

Kotlin ReviewQuery DTOs

GET /rating/reviews HTTP/1.1 
Host: api-staging.bookmore.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}