Cochrane+ App API

<back to all web services

GetSalesTargetInfo

Requires Authentication
The following routes are available for this service:
GET/dashboard/salestargetinfo
import Foundation
import ServiceStack

public class GetSalesTargetInfo : 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 GetSalesTargetInfoResponse : ApiServiceResponse
{
    public var totalMeetings:Double
    public var averageTime:String
    public var averageQuality:Double
    public var averageRating:Double
    public var meetingsGoal:Int
    public var averageQualityGoal:Int
    public var averageTimeGoal:String
    public var averageRatingGoal:Int

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

    private enum CodingKeys : String, CodingKey {
        case totalMeetings
        case averageTime
        case averageQuality
        case averageRating
        case meetingsGoal
        case averageQualityGoal
        case averageTimeGoal
        case averageRatingGoal
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        totalMeetings = try container.decodeIfPresent(Double.self, forKey: .totalMeetings)
        averageTime = try container.decodeIfPresent(String.self, forKey: .averageTime)
        averageQuality = try container.decodeIfPresent(Double.self, forKey: .averageQuality)
        averageRating = try container.decodeIfPresent(Double.self, forKey: .averageRating)
        meetingsGoal = try container.decodeIfPresent(Int.self, forKey: .meetingsGoal)
        averageQualityGoal = try container.decodeIfPresent(Int.self, forKey: .averageQualityGoal)
        averageTimeGoal = try container.decodeIfPresent(String.self, forKey: .averageTimeGoal)
        averageRatingGoal = try container.decodeIfPresent(Int.self, forKey: .averageRatingGoal)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if totalMeetings != nil { try container.encode(totalMeetings, forKey: .totalMeetings) }
        if averageTime != nil { try container.encode(averageTime, forKey: .averageTime) }
        if averageQuality != nil { try container.encode(averageQuality, forKey: .averageQuality) }
        if averageRating != nil { try container.encode(averageRating, forKey: .averageRating) }
        if meetingsGoal != nil { try container.encode(meetingsGoal, forKey: .meetingsGoal) }
        if averageQualityGoal != nil { try container.encode(averageQualityGoal, forKey: .averageQualityGoal) }
        if averageTimeGoal != nil { try container.encode(averageTimeGoal, forKey: .averageTimeGoal) }
        if averageRatingGoal != nil { try container.encode(averageRatingGoal, forKey: .averageRatingGoal) }
    }
}

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(){}
}


Swift GetSalesTargetInfo 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 /dashboard/salestargetinfo HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"totalMeetings":0,"averageTime":"String","averageQuality":0,"averageRating":0,"meetingsGoal":0,"averageQualityGoal":0,"averageTimeGoal":"String","averageRatingGoal":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}