Cochrane+ App API

<back to all web services

Migrate

The following routes are available for this service:
GET/migrateMigration method used to perform custom logic
import Foundation
import ServiceStack

public class Migrate : Codable
{
    required public init(){}
}

public class MigrateResponse : ApiServiceResponse
{
    public var recordsUpdated:Int
    public var recordsDeleted:Int
    public var recordsAdded:Int

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

    private enum CodingKeys : String, CodingKey {
        case recordsUpdated
        case recordsDeleted
        case recordsAdded
    }

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

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

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 Migrate 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.

GET /migrate HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/xml

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

<MigrateResponse 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>
  <RecordsAdded>0</RecordsAdded>
  <RecordsDeleted>0</RecordsDeleted>
  <RecordsUpdated>0</RecordsUpdated>
</MigrateResponse>