Cochrane+ App API

<back to all web services

GetUsersRatings

Requires Authentication
The following routes are available for this service:
GET/internalrating/getusersratings
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 RatingSubmissionListItem() = 
        member val Id:Int32 = new Int32() with get,set
        member val ProfileImage:String = null with get,set
        member val TemplateName:String = null with get,set
        member val Username:String = null with get,set
        member val Value:Int32 = new Int32() with get,set
        member val Comments:String = null with get,set
        member val DateRated:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type GetRatingSubmissionsResponse() = 
        inherit ApiServiceResponse()
        member val RatingSubmissions:ResizeArray<RatingSubmissionListItem> = new ResizeArray<RatingSubmissionListItem>() 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 GetUsersRatings() = 
        inherit ApiServiceRequest()

F# GetUsersRatings DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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":{}}