Client_Initiations

ClientDownloadRequest

The following routes are available for this service:
POST, PUT	/documents/download

import Foundation
import ServiceStack

public class ClientDownloadRequest : DocumentRequestBase
{
    public var fileName:String
    /**
    * Month
    */
    // @ApiMember(Description="Month", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    public var month:Int

    /**
    * Day
    */
    // @ApiMember(Description="Day", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    public var day:Int

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

    private enum CodingKeys : String, CodingKey {
        case fileName
        case month
        case day
    }

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

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

public class DocumentRequestBase : Codable
{
    /**
    * ExternalID
    */
    // @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    public var externalId:String

    required public init(){}
}

public class ClientDownloadResponse : ResponseBase
{
    public var fileName:String
    public var stream:Data

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

    private enum CodingKeys : String, CodingKey {
        case fileName
        case stream
    }

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

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

public class ResponseBase : Codable
{
    public var message:String
    public var isSuccess:Bool

    required public init(){}
}

Swift ClientDownloadRequest 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 /documents/download HTTP/1.1 
Host: initiation-pen.sirva.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ClientDownloadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <ExternalId>String</ExternalId>
  <Day>0</Day>
  <FileName>String</FileName>
  <Month>0</Month>
</ClientDownloadRequest>

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

<ClientDownloadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <IsSuccess>false</IsSuccess>
  <Message>String</Message>
  <FileName>String</FileName>
  <Stream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
</ClientDownloadResponse>