Cochrane+ App API

<back to all web services

GetPromoteToUserOptionsRequest

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

public class GetPromoteToUserOptionsRequest : ApiServiceRequest
{
    public var id:Int

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

    private enum CodingKeys : String, CodingKey {
        case id
    }

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

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

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 GetPromoteToUserOptionsResponse : ApiServiceResponse
{
    public var promotedToUserIds:[Int] = []
    public var userOptions:[DebriefPromoteToUserOption] = []

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

    private enum CodingKeys : String, CodingKey {
        case promotedToUserIds
        case userOptions
    }

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

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

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 DebriefPromoteToUserOption : Codable
{
    public var id:Int
    public var name:String

    required public init(){}
}


Swift GetPromoteToUserOptionsRequest 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 /debriefreview/promoteoptions/{Id} HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"promotedToUserIds":[0],"userOptions":[{}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}