Client_Initiations

ClientDownloadRequest

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

namespace Client_Initiations.ServiceModel.ClientUpload

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentRequestBase() = 
        ///<summary>
        ///ExternalID
        ///</summary>
        [<ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")>]
        member val ExternalId:String = null with get,set

    [<AllowNullLiteral>]
    type ClientDownloadRequest() = 
        inherit DocumentRequestBase()
        member val FileName:String = null with get,set
        ///<summary>
        ///Month
        ///</summary>
        [<ApiMember(Description="Month", ExcludeInSchema=true, IsRequired=true, ParameterType="path")>]
        member val Month:Int32 = new Int32() with get,set

        ///<summary>
        ///Day
        ///</summary>
        [<ApiMember(Description="Day", ExcludeInSchema=true, IsRequired=true, ParameterType="path")>]
        member val Day:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ResponseBase() = 
        member val Message:String = null with get,set
        member val IsSuccess:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ClientDownloadResponse() = 
        inherit ResponseBase()
        member val FileName:String = null with get,set
        member val Stream:Stream = null with get,set

F# 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>