Cochrane+ App API

<back to all web services

OnTheMoveHeatMapRequest

import Foundation
import ServiceStack

public class OnTheMoveHeatMapRequest : ApiServiceRequest
{
    public var id:Int
    public var startDate:Date
    public var endDate:Date

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

    private enum CodingKeys : String, CodingKey {
        case id
        case startDate
        case endDate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        startDate = try container.decodeIfPresent(Date.self, forKey: .startDate)
        endDate = try container.decodeIfPresent(Date.self, forKey: .endDate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if startDate != nil { try container.encode(startDate, forKey: .startDate) }
        if endDate != nil { try container.encode(endDate, forKey: .endDate) }
    }
}

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 OnTheMoveHeatMapResponse : ApiServiceResponse
{
    public var points:[Coordinate] = []

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

    private enum CodingKeys : String, CodingKey {
        case points
    }

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

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

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 Coordinate : Codable
{
    public var latitude:Double
    public var longitude:Double

    required public init(){}
}

Swift OnTheMoveHeatMapRequest DTOs

GET /template-approval/detail HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/csv

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

{"points":[{"latitude":0,"longitude":0}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}