Cochrane+ App API

<back to all web services

StartJourney

import Foundation
import ServiceStack

public class StartJourney : ApiServiceRequest
{
    public var title:String
    public var crmMeetingId:String
    public var meetingCompany:String
    public var meetingContact:String
    public var meetingSubject:String

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

    private enum CodingKeys : String, CodingKey {
        case title
        case crmMeetingId
        case meetingCompany
        case meetingContact
        case meetingSubject
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        title = try container.decodeIfPresent(String.self, forKey: .title)
        crmMeetingId = try container.decodeIfPresent(String.self, forKey: .crmMeetingId)
        meetingCompany = try container.decodeIfPresent(String.self, forKey: .meetingCompany)
        meetingContact = try container.decodeIfPresent(String.self, forKey: .meetingContact)
        meetingSubject = try container.decodeIfPresent(String.self, forKey: .meetingSubject)
    }

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

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 StartJourneyResponse : ApiServiceResponse
{
    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 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 StartJourney DTOs

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

{
	title: String,
	crmMeetingId: 00000000-0000-0000-0000-000000000000,
	meetingCompany: String,
	meetingContact: String,
	meetingSubject: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

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

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