Cochrane+ App API

<back to all web services

OnTheMoveDetailRequest

Requires Authentication
The following routes are available for this service:
GET/template-approval/detail
import Foundation
import ServiceStack

public class OnTheMoveDetailRequest : ApiServiceRequest
{
    public var id:Int
    public var date:Date

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

    private enum CodingKeys : String, CodingKey {
        case id
        case date
    }

    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)
        date = try container.decodeIfPresent(Date.self, forKey: .date)
    }

    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 date != nil { try container.encode(date, forKey: .date) }
    }
}

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 OnTheMoveDetailResponse : ApiServiceResponse
{
    public var systemUserName:String
    public var meetings:[OnTheMoveMeetingListItem] = []
    public var points:[JourneyPoints] = []

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

    private enum CodingKeys : String, CodingKey {
        case systemUserName
        case meetings
        case points
    }

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

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if systemUserName != nil { try container.encode(systemUserName, forKey: .systemUserName) }
        if meetings.count > 0 { try container.encode(meetings, forKey: .meetings) }
        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 OnTheMoveMeetingListItem : Codable
{
    public var id:Int
    public var company:String
    public var subject:String
    public var startDate:String
    public var arrivedDate:String
    public var leftDate:String
    public var duration:String
    public var latitude:Double
    public var longitude:Double
    public var contactName:String
    public var virtualOrInPerson:String
    public var meetingSetBy:String
    public var zoomUrl:String

    required public init(){}
}

public class JourneyPoints : Codable
{
    public var latitude:Double
    public var longitude:Double
    public var time:String

    required public init(){}
}


Swift OnTheMoveDetailRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /template-approval/detail HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	systemUserName: String,
	meetings: 
	[
		{
			
		}
	],
	points: 
	[
		{
			
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}