Cochrane+ App API

EndJourney

The following routes are available for this service:
POST	/journey/end

import Foundation
import ServiceStack

public class EndJourney : ApiServiceRequest
{
    public var journeyId:Int

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

    private enum CodingKeys : String, CodingKey {
        case journeyId
    }

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

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

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 EndJourneyResponse : ApiServiceResponse
{
    public var journey:JourneyData

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

    private enum CodingKeys : String, CodingKey {
        case journey
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        journey = try container.decodeIfPresent(JourneyData.self, forKey: .journey)
    }

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

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 JourneyData : Codable
{
    public var journeyId:Int
    public var title:String
    public var startTime:String
    public var endTime:String
    public var distance:Double
    public var distanceFormatted:String
    public var routePolyline:String
    public var startPoint:JourneyPointData
    public var endPoint:JourneyPointData
    public var meetingData:MeetingData
    public var journeyNotes:[JourneyNoteData] = []

    required public init(){}
}

public class JourneyPointData : Codable
{
    public var latitude:Double
    public var longitude:Double
    public var address:String

    required public init(){}
}

public class MeetingData : Codable
{
    public var meetingId:Int
    public var startTime:String
    public var arrivalTime:String
    public var leftTime:String
    public var duration:String
    public var showTimeFields:Bool
    public var arrivalStatus:String
    public var email:String
    public var hasEmail:Bool
    public var contactName:String
    public var latitude:Double
    public var longitude:Double
    public var location:String
    public var address:String
    public var subject:String
    public var Description:String
    public var endTime:String
    public var company:String
    public var contactNumber:String
    public var hasContactNumber:Bool
    public var hasLocation:Bool
    public var setBy:String
    public var virtualOrInPerson:String

    required public init(){}
}

public class JourneyNoteData : Codable
{
    public var note:String
    public var date:String

    required public init(){}
}

Swift EndJourney DTOs

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

HTTP + OTHER

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

POST /journey/end HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"journeyId":0,"apiKey":"String","latitude":0,"longitude":0}

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

{"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}