Client_Initiations

ClientDownloadRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class ClientDownloadRequest : DocumentRequestBase()
{
    var FileName:String? = null
    /**
    * Month
    */
    @ApiMember(Description="Month", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    var Month:Int? = null

    /**
    * Day
    */
    @ApiMember(Description="Day", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    var Day:Int? = null
}

open class DocumentRequestBase
{
    /**
    * ExternalID
    */
    @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    var ExternalId:String? = null
}

open class ClientDownloadResponse : ResponseBase()
{
    var FileName:String? = null
    var Stream:InputStream? = null
}

open class ResponseBase
{
    var Message:String? = null
    var IsSuccess:Boolean? = null
}

Kotlin 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>