Cochrane+ App API

<back to all web services

GetUsersRatings

Requires Authentication
The following routes are available for this service:
GET/internalrating/getusersratings
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
using CommonService.Api.Models.Base;

namespace CommonService.Api.Models.Base
{
    public partial class ApiServiceResponse
        : IServiceResponse
    {
        public virtual string Description { get; set; }
        public virtual string Heading { get; set; }
        public virtual bool WasSuccessful { get; set; }
        public virtual Object ModelState { get; set; }
    }

}

namespace WebService.ServiceModel
{
    public partial class GetRatingSubmissionsResponse
        : ApiServiceResponse
    {
        public GetRatingSubmissionsResponse()
        {
            RatingSubmissions = new List<RatingSubmissionListItem>{};
        }

        public virtual List<RatingSubmissionListItem> RatingSubmissions { get; set; }
    }

    public partial class GetUsersRatings
        : ApiServiceRequest
    {
    }

    public partial class RatingSubmissionListItem
    {
        public virtual int Id { get; set; }
        public virtual string ProfileImage { get; set; }
        public virtual string TemplateName { get; set; }
        public virtual string Username { get; set; }
        public virtual int Value { get; set; }
        public virtual string Comments { get; set; }
        public virtual DateTime DateRated { get; set; }
    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

}

C# GetUsersRatings 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/getusersratings HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ratingSubmissions: 
	[
		{
			id: 0,
			profileImage: String,
			templateName: String,
			username: String,
			value: 0,
			comments: String,
			dateRated: 0001-01-01
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}