Cochrane+ App API

<back to all web services

GetActiveJourney

Requires Authentication
The following routes are available for this service:
GET/journey/active
import Foundation
import ServiceStack

public class GetActiveJourney : 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 GetActiveJourneyResponse : ApiServiceResponse
{
    public var journeyAvailable:Bool
    public var journeyTitle:String
    public var journeyId:Int

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

    private enum CodingKeys : String, CodingKey {
        case journeyAvailable
        case journeyTitle
        case journeyId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        journeyAvailable = try container.decodeIfPresent(Bool.self, forKey: .journeyAvailable)
        journeyTitle = try container.decodeIfPresent(String.self, forKey: .journeyTitle)
        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 journeyAvailable != nil { try container.encode(journeyAvailable, forKey: .journeyAvailable) }
        if journeyTitle != nil { try container.encode(journeyTitle, forKey: .journeyTitle) }
        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 GetActiveJourney 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.

GET /journey/active HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'GetActiveJourneyResponse' using the custom 'other' filter}Cannot dynamically create an instance of type 'WebService.ServiceModel.GetActiveJourneyResponse'. Reason: No parameterless constructor defined.