BokaMera.API.Host

<back to all web services

RatingQuery

The following routes are available for this service:
GET/rating/Get RatingsGet Ratings.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Db

Namespace Global

    Namespace BokaMera.API.ServiceModel.Db

        Public Partial Class BaseModel
        End Class

        Public Partial Class Rating
            Inherits BaseModel
            Public Overridable Property ReviewId As Nullable(Of Guid)
            Public Overridable Property Review As Review
            <Required>
            Public Overridable Property CompanyId As Guid

            <Required>
            Public Overridable Property BookingId As Integer

            <Required>
            Public Overridable Property RatingScore As Integer

            <Required>
            Public Overridable Property Status As Integer

            <Required>
            Public Overridable Property Created As Date

            <Required>
            Public Overridable Property Updated As Date

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
        End Class

        Public Partial Class Review
            Inherits BaseModel
            Public Overridable Property ReviewId As Guid
            <Required>
            Public Overridable Property CompanyId As Guid

            <Required>
            Public Overridable Property Title As String

            <Required>
            Public Overridable Property Description As String

            <Required>
            Public Overridable Property Author As String

            <Required>
            Public Overridable Property Status As Integer

            <Required>
            Public Overridable Property Created As Date

            <Required>
            Public Overridable Property Updated As Date

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
            Public Overridable Property ReviewAnswer As String
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class AccessKeyTypeResponse
            Public Overridable Property Id As Integer
            Public Overridable Property KeyType As String
            Public Overridable Property Description As String
        End Class

        Public Partial Class CompanyRatingResponse
            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="")>
            Public Overridable Property CompanyId As Guid

            '''<Summary>
            '''Id of the booking
            '''</Summary>
            <ApiMember(Description:="Id of the booking")>
            Public Overridable Property BookingId As Integer

            '''<Summary>
            '''The status of the rating, 1 = Active
            '''</Summary>
            <ApiMember(Description:="The status of the rating, 1 = Active")>
            Public Overridable Property Status As Integer

            '''<Summary>
            '''The rating score
            '''</Summary>
            <ApiMember(Description:="The rating score")>
            Public Overridable Property RatingScore As Integer

            '''<Summary>
            '''The review if any exists to the rating
            '''</Summary>
            <ApiMember(Description:="The review if any exists to the rating")>
            Public Overridable Property Review As RatingReviewResponse

            Public Overridable Property CreatedDate As Date
            Public Overridable Property UpdatedDate As Date
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class RatingQuery
            Inherits QueryDb(Of Rating, CompanyRatingResponse)
            Implements ICompany
            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Id of the booking
            '''</Summary>
            <DataMember(Name:="BookedEventId")>
            <ApiMember(Description:="Id of the booking")>
            Public Overridable Property BookingId As Nullable(Of Integer)

            '''<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 Overridable Property Active As Nullable(Of Boolean)

            '''<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 Overridable Property IncludeRatingReviews As Boolean

            '''<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 Overridable Property CreatedFrom As Nullable(Of Date)

            '''<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 Overridable Property CreatedTo As Nullable(Of Date)
        End Class

        Public Partial Class RatingReviewResponse
            '''<Summary>
            '''The title for the review
            '''</Summary>
            <ApiMember(Description:="The title for the review")>
            Public Overridable Property Title As String

            '''<Summary>
            '''The description for the review
            '''</Summary>
            <ApiMember(Description:="The description for the review")>
            Public Overridable Property Description As String

            '''<Summary>
            '''The rating score
            '''</Summary>
            <ApiMember(Description:="The rating score")>
            Public Overridable Property RatingScore As Integer

            '''<Summary>
            '''The review author
            '''</Summary>
            <ApiMember(Description:="The review author")>
            Public Overridable Property Author As String

            '''<Summary>
            '''The created date
            '''</Summary>
            <ApiMember(Description:="The created date")>
            Public Overridable Property Created As Date

            '''<Summary>
            '''The review answer from the company
            '''</Summary>
            <ApiMember(Description:="The review answer from the company")>
            Public Overridable Property ReviewAnswer As String
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            '''<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 Overridable Property Skip As Nullable(Of Integer)

            '''<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 Overridable Property Take As Nullable(Of Integer)

            '''<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 Overridable Property OrderBy As String

            '''<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 Overridable Property OrderByDesc As String

            '''<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 Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of From, Into)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of AccessKeyTypeResponse)
            Public Sub New()
                Results = New List(Of AccessKeyTypeResponse)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of AccessKeyTypeResponse)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET RatingQuery DTOs

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

HTTP + CSV

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/csv

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