Cochrane+ App API

<back to all web services

GetRatingLeaderboard

import Foundation
import ServiceStack

public class GetRatingLeaderboard : ApiServiceRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

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

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

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public var longitude:Double

    required public init(){}
}

public class GetRatingLeaderboardResponse : ApiServiceResponse
{
    public var leaderboardItems:[RatingLeaderboardItem] = []
    public var myPosition:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case leaderboardItems
        case myPosition
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        leaderboardItems = try container.decodeIfPresent([RatingLeaderboardItem].self, forKey: .leaderboardItems) ?? []
        myPosition = try container.decodeIfPresent(Int.self, forKey: .myPosition)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if leaderboardItems.count > 0 { try container.encode(leaderboardItems, forKey: .leaderboardItems) }
        if myPosition != nil { try container.encode(myPosition, forKey: .myPosition) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

public class RatingLeaderboardItem : Codable
{
    public var systemUserId:Int
    public var profileImage:String
    public var fullName:String
    public var averageRating:Double
    public var totalVotes:Int
    public var position:String

    required public init(){}
}

Swift GetRatingLeaderboard DTOs

GET /internalrating/getratingleaderboardlist HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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