Cochrane+ App API

<back to all web services

GetRatingSubmissions

Requires Authentication
The following routes are available for this service:
GET/internalrating/getratingslist
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 RatingSubmissionListItem implements IConvertible
{
    int? id;
    String? profileImage;
    String? templateName;
    String? username;
    int? value;
    String? comments;
    DateTime? dateRated;

    RatingSubmissionListItem({this.id,this.profileImage,this.templateName,this.username,this.value,this.comments,this.dateRated});
    RatingSubmissionListItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        profileImage = json['profileImage'];
        templateName = json['templateName'];
        username = json['username'];
        value = json['value'];
        comments = json['comments'];
        dateRated = JsonConverters.fromJson(json['dateRated'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'profileImage': profileImage,
        'templateName': templateName,
        'username': username,
        'value': value,
        'comments': comments,
        'dateRated': JsonConverters.toJson(dateRated,'DateTime',context!)
    };

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

class GetRatingSubmissionsResponse extends ApiServiceResponse implements IConvertible
{
    List<RatingSubmissionListItem>? ratingSubmissions;

    GetRatingSubmissionsResponse({this.ratingSubmissions});
    GetRatingSubmissionsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class GetRatingSubmissions extends ApiServiceRequest implements IConvertible
{
    GetRatingSubmissions();
    GetRatingSubmissions.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() => "GetRatingSubmissions";
    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()),
    'RatingSubmissionListItem': TypeInfo(TypeOf.Class, create:() => RatingSubmissionListItem()),
    'GetRatingSubmissionsResponse': TypeInfo(TypeOf.Class, create:() => GetRatingSubmissionsResponse()),
    'List<RatingSubmissionListItem>': TypeInfo(TypeOf.Class, create:() => <RatingSubmissionListItem>[]),
    'GetRatingSubmissions': TypeInfo(TypeOf.Class, create:() => GetRatingSubmissions()),
});

Dart GetRatingSubmissions 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 /internalrating/getratingslist HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ratingSubmissions":[{"id":0,"profileImage":"String","templateName":"String","username":"String","value":0,"comments":"String","dateRated":"0001-01-01T00:00:00.0000000"}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}