Cochrane+ App API

<back to all web services

GetDebriefMeetingList

Requires Authentication
The following routes are available for this service:
GET/debrief/meetings/{Id}
import Foundation
import ServiceStack

public class GetDebriefMeetingList : ApiServiceRequest
{
    public var debriefId:Int

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

    private enum CodingKeys : String, CodingKey {
        case debriefId
    }

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

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

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 GetDebriefMeetingListResponse : ApiServiceResponse
{
    public var meetings:[MeetingData] = []

    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([MeetingData].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 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(){}
}


Swift GetDebriefMeetingList 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 /debrief/meetings/{Id} HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	meetings: 
	[
		{
			meetingId: 0,
			startTime: String,
			arrivalTime: String,
			leftTime: String,
			duration: String,
			showTimeFields: False,
			arrivalStatus: String,
			email: String,
			hasEmail: True,
			contactName: String,
			latitude: 0,
			longitude: 0,
			location: String,
			address: String,
			subject: String,
			description: String,
			endTime: String,
			company: String,
			contactNumber: String,
			hasContactNumber: True,
			hasLocation: False,
			setBy: String,
			virtualOrInPerson: String
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}