Cochrane+ App API

<back to all web services

GetRatingLeaderboard

Requires Authentication
The following routes are available for this service:
GET/internalrating/getratingleaderboardlist
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
GetRatingLeaderboardResponse Parameters:
NameParameterData TypeRequiredDescription
LeaderboardItemsformList<RatingLeaderboardItem>No
MyPositionformintNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
RatingLeaderboardItem Parameters:
NameParameterData TypeRequiredDescription
SystemUserIdformintNo
ProfileImageformstringNo
FullNameformstringNo
AverageRatingformdoubleNo
TotalVotesformintNo
PositionformstringNo

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

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