Cochrane+ App API

<back to all web services

GetRatingLeaderboard

Requires Authentication
The following routes are available for this service:
GET/internalrating/getratingleaderboardlist
namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        member val Description:String = null with get,set
        member val Heading:String = null with get,set
        member val WasSuccessful:Boolean = new Boolean() with get,set
        member val ModelState:Object = null with get,set

    [<AllowNullLiteral>]
    type RatingLeaderboardItem() = 
        member val SystemUserId:Int32 = new Int32() with get,set
        member val ProfileImage:String = null with get,set
        member val FullName:String = null with get,set
        member val AverageRating:Double = new Double() with get,set
        member val TotalVotes:Int32 = new Int32() with get,set
        member val Position:String = null with get,set

    [<AllowNullLiteral>]
    type GetRatingLeaderboardResponse() = 
        inherit ApiServiceResponse()
        member val LeaderboardItems:ResizeArray<RatingLeaderboardItem> = new ResizeArray<RatingLeaderboardItem>() with get,set
        member val MyPosition:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type GetRatingLeaderboard() = 
        inherit ApiServiceRequest()

F# GetRatingLeaderboard DTOs

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

HTTP + JSV

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

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