Cochrane+ App API

<back to all web services

OnTheMoveListRequest

import Foundation
import ServiceStack

public class OnTheMoveListRequest : 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 OnTheMoveListResponse : ApiServiceResponse
{
    public var listItems:[OnTheMoveListItem] = []

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

    private enum CodingKeys : String, CodingKey {
        case listItems
    }

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

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

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 OnTheMoveListItem : Codable
{
    public var id:Int
    public var name:String
    public var clockedInTime:String
    public var lastSeen:String
    public var lastKnownLocation:String
    public var coordinate:Coordinate

    required public init(){}
}

public class Coordinate : Codable
{
    public var latitude:Double
    public var longitude:Double

    required public init(){}
}

Swift OnTheMoveListRequest DTOs

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

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

{
	listItems: 
	[
		{
			id: 0,
			name: String,
			clockedInTime: String,
			lastSeen: String,
			lastKnownLocation: String,
			coordinate: 
			{
				latitude: 0,
				longitude: 0
			}
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}