Cochrane+ App API

GetRatingLeaderboard

The following routes are available for this service:
GET	/internalrating/getratingleaderboardlist

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base
Imports CommonService.Api.Models.Base

Namespace Global

    Namespace CommonService.Api.Models.Base

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            Public Overridable Property Description As String
            Public Overridable Property Heading As String
            Public Overridable Property WasSuccessful As Boolean
            Public Overridable Property ModelState As Object
        End Class
    End Namespace

    Namespace WebService.ServiceModel

        Public Partial Class GetRatingLeaderboard
            Inherits ApiServiceRequest
        End Class

        Public Partial Class GetRatingLeaderboardResponse
            Inherits ApiServiceResponse
            Public Sub New()
                LeaderboardItems = New List(Of RatingLeaderboardItem)
            End Sub

            Public Overridable Property LeaderboardItems As List(Of RatingLeaderboardItem)
            Public Overridable Property MyPosition As Integer
        End Class

        Public Partial Class RatingLeaderboardItem
            Public Overridable Property SystemUserId As Integer
            Public Overridable Property ProfileImage As String
            Public Overridable Property FullName As String
            Public Overridable Property AverageRating As Double
            Public Overridable Property TotalVotes As Integer
            Public Overridable Property Position As String
        End Class
    End Namespace

    Namespace WebService.ServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            Implements IHasDeviceInfo
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Latitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
            Public Overridable Property Latitude As Double

            '''<Summary>
            '''Longitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
            Public Overridable Property Longitude As Double
        End Class
    End Namespace
End Namespace

VB.NET GetRatingLeaderboard DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /internalrating/getratingleaderboardlist HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json

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

{"leaderboardItems":[{}],"myPosition":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}