Cochrane+ App API

<back to all web services

GetUsersRatings

Requires Authentication
The following routes are available for this service:
GET/internalrating/getusersratings
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetUsersRatings extends ApiServiceRequest
    {
        
    }

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

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

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class GetRatingSubmissionsResponse extends ApiServiceResponse
    {
        public ArrayList<RatingSubmissionListItem> ratingSubmissions = null;
        
        public ArrayList<RatingSubmissionListItem> getRatingSubmissions() { return ratingSubmissions; }
        public GetRatingSubmissionsResponse setRatingSubmissions(ArrayList<RatingSubmissionListItem> value) { this.ratingSubmissions = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        public String description = null;
        public String heading = null;
        public Boolean wasSuccessful = null;
        public Object modelState = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public Object getModelState() { return modelState; }
        public ApiServiceResponse setModelState(Object value) { this.modelState = value; return this; }
    }

    public static class RatingSubmissionListItem
    {
        public Integer id = null;
        public String profileImage = null;
        public String templateName = null;
        public String username = null;
        public Integer value = null;
        public String comments = null;
        public Date dateRated = null;
        
        public Integer getId() { return id; }
        public RatingSubmissionListItem setId(Integer value) { this.id = value; return this; }
        public String getProfileImage() { return profileImage; }
        public RatingSubmissionListItem setProfileImage(String value) { this.profileImage = value; return this; }
        public String getTemplateName() { return templateName; }
        public RatingSubmissionListItem setTemplateName(String value) { this.templateName = value; return this; }
        public String getUsername() { return username; }
        public RatingSubmissionListItem setUsername(String value) { this.username = value; return this; }
        public Integer getValue() { return value; }
        public RatingSubmissionListItem setValue(Integer value) { this.value = value; return this; }
        public String getComments() { return comments; }
        public RatingSubmissionListItem setComments(String value) { this.comments = value; return this; }
        public Date getDateRated() { return dateRated; }
        public RatingSubmissionListItem setDateRated(Date value) { this.dateRated = value; return this; }
    }

}

Java 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: {}
}