Cochrane+ App API

<back to all web services

GetJourneyMeetings

Requires Authentication
import Foundation
import ServiceStack

public class GetJourneyMeetings : 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 GetJourneyMeetingsResponse : ApiServiceResponse
{
    public var meetings:[JourneyMeetingData] = []

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

    private enum CodingKeys : String, CodingKey {
        case meetings
    }

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

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

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 JourneyMeetingData : Codable
{
    public var crmMeetingId:String
    public var meetingSubject:String
    public var meetingContact:String
    public var meetingCompany:String
    public var startTime:String

    required public init(){}
}


Swift GetJourneyMeetings DTOs

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

HTTP + XML

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

POST /xml/reply/GetJourneyMeetings HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetJourneyMeetings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
</GetJourneyMeetings>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetJourneyMeetingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <Meetings>
    <JourneyMeetingData>
      <CrmMeetingId>String</CrmMeetingId>
      <MeetingCompany>String</MeetingCompany>
      <MeetingContact>String</MeetingContact>
      <MeetingSubject>String</MeetingSubject>
      <StartTime>String</StartTime>
    </JourneyMeetingData>
  </Meetings>
</GetJourneyMeetingsResponse>