Cochrane+ App API

<back to all web services

GetRatingLeaderboard

Requires Authentication
The following routes are available for this service:
GET/internalrating/getratingleaderboardlist
import 'package:servicestack/servicestack.dart';

class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, IConvertible
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    String? apiKey;

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    double? latitude;

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    double? longitude;

    ApiServiceRequest({this.apiKey,this.latitude,this.longitude});
    ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiKey = json['apiKey'];
        latitude = JsonConverters.toDouble(json['latitude']);
        longitude = JsonConverters.toDouble(json['longitude']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiKey': apiKey,
        'latitude': latitude,
        'longitude': longitude
    };

    getTypeName() => "ApiServiceRequest";
    TypeContext? context = _ctx;
}

class ApiServiceResponse implements IServiceResponse, IConvertible
{
    String? description;
    String? heading;
    bool? wasSuccessful;
    dynamic? modelState;

    ApiServiceResponse({this.description,this.heading,this.wasSuccessful,this.modelState});
    ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        description = json['description'];
        heading = json['heading'];
        wasSuccessful = json['wasSuccessful'];
        modelState = JsonConverters.fromJson(json['modelState'],'dynamic',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'description': description,
        'heading': heading,
        'wasSuccessful': wasSuccessful,
        'modelState': JsonConverters.toJson(modelState,'dynamic',context!)
    };

    getTypeName() => "ApiServiceResponse";
    TypeContext? context = _ctx;
}

class RatingLeaderboardItem implements IConvertible
{
    int? systemUserId;
    String? profileImage;
    String? fullName;
    double? averageRating;
    int? totalVotes;
    String? position;

    RatingLeaderboardItem({this.systemUserId,this.profileImage,this.fullName,this.averageRating,this.totalVotes,this.position});
    RatingLeaderboardItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        systemUserId = json['systemUserId'];
        profileImage = json['profileImage'];
        fullName = json['fullName'];
        averageRating = JsonConverters.toDouble(json['averageRating']);
        totalVotes = json['totalVotes'];
        position = json['position'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'systemUserId': systemUserId,
        'profileImage': profileImage,
        'fullName': fullName,
        'averageRating': averageRating,
        'totalVotes': totalVotes,
        'position': position
    };

    getTypeName() => "RatingLeaderboardItem";
    TypeContext? context = _ctx;
}

class GetRatingLeaderboardResponse extends ApiServiceResponse implements IConvertible
{
    List<RatingLeaderboardItem>? leaderboardItems;
    int? myPosition;

    GetRatingLeaderboardResponse({this.leaderboardItems,this.myPosition});
    GetRatingLeaderboardResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        leaderboardItems = JsonConverters.fromJson(json['leaderboardItems'],'List<RatingLeaderboardItem>',context!);
        myPosition = json['myPosition'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'leaderboardItems': JsonConverters.toJson(leaderboardItems,'List<RatingLeaderboardItem>',context!),
        'myPosition': myPosition
    });

    getTypeName() => "GetRatingLeaderboardResponse";
    TypeContext? context = _ctx;
}

class GetRatingLeaderboard extends ApiServiceRequest implements IConvertible
{
    GetRatingLeaderboard();
    GetRatingLeaderboard.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetRatingLeaderboard";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'cochraneplus_api_dev.happen.zone', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'RatingLeaderboardItem': TypeInfo(TypeOf.Class, create:() => RatingLeaderboardItem()),
    'GetRatingLeaderboardResponse': TypeInfo(TypeOf.Class, create:() => GetRatingLeaderboardResponse()),
    'List<RatingLeaderboardItem>': TypeInfo(TypeOf.Class, create:() => <RatingLeaderboardItem>[]),
    'GetRatingLeaderboard': TypeInfo(TypeOf.Class, create:() => GetRatingLeaderboard()),
});

Dart GetRatingLeaderboard DTOs

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

HTTP + OTHER

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

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