Cochrane+ App API

<back to all web services

AppHeartbeat

import Foundation
import ServiceStack

public class AppHeartbeat : ApiServiceRequest
{
    public var systemUserId:Int
    public var batteryLevel:Double
    public var fromApp:Bool

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

    private enum CodingKeys : String, CodingKey {
        case systemUserId
        case batteryLevel
        case fromApp
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        systemUserId = try container.decodeIfPresent(Int.self, forKey: .systemUserId)
        batteryLevel = try container.decodeIfPresent(Double.self, forKey: .batteryLevel)
        fromApp = try container.decodeIfPresent(Bool.self, forKey: .fromApp)
    }

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

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 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 AppHeartbeat DTOs

POST /app/heartbeat HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	systemUserId: 0,
	batteryLevel: 0,
	fromApp: False,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

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

{
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}