Cochrane+ App API

TemplateApprovalReview

The following routes are available for this service:
POST	/template-approval/list

import Foundation
import ServiceStack

public class TemplateApprovalReview : ApiServiceRequest
{
    public var templateApprovalId:Int
    public var approvalStatus:TemplateApprovalStatus

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

    private enum CodingKeys : String, CodingKey {
        case templateApprovalId
        case approvalStatus
    }

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

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

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 enum TemplateApprovalStatus : Int, Codable
{
    case AwaitingApproval = 0
    case Rejected = 1
    case Approved = 2
}

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 TemplateApprovalReview 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 /template-approval/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TemplateApprovalReview 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>
  <ApprovalStatus>AwaitingApproval</ApprovalStatus>
  <TemplateApprovalId>0</TemplateApprovalId>
</TemplateApprovalReview>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">
  <Description>String</Description>
  <Heading>String</Heading>
  <ModelState />
  <WasSuccessful>false</WasSuccessful>
</ApiServiceResponse>