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.*;

public class dtos
{

    public static class ClientDownloadRequest extends DocumentRequestBase
    {
        public String FileName = null;
        /**
        * Month
        */
        @ApiMember(Description="Month", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
        public Integer Month = null;

        /**
        * Day
        */
        @ApiMember(Description="Day", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
        public Integer Day = null;
        
        public String getFileName() { return FileName; }
        public ClientDownloadRequest setFileName(String value) { this.FileName = value; return this; }
        public Integer getMonth() { return Month; }
        public ClientDownloadRequest setMonth(Integer value) { this.Month = value; return this; }
        public Integer getDay() { return Day; }
        public ClientDownloadRequest setDay(Integer value) { this.Day = value; return this; }
    }

    public static class DocumentRequestBase
    {
        /**
        * ExternalID
        */
        @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
        public String ExternalId = null;
        
        public String getExternalId() { return ExternalId; }
        public DocumentRequestBase setExternalId(String value) { this.ExternalId = value; return this; }
    }

    public static class ClientDownloadResponse extends ResponseBase
    {
        public String FileName = null;
        public InputStream Stream = null;
        
        public String getFileName() { return FileName; }
        public ClientDownloadResponse setFileName(String value) { this.FileName = value; return this; }
        public InputStream getStream() { return Stream; }
        public ClientDownloadResponse setStream(InputStream value) { this.Stream = value; return this; }
    }

    public static class ResponseBase
    {
        public String Message = null;
        public Boolean IsSuccess = null;
        
        public String getMessage() { return Message; }
        public ResponseBase setMessage(String value) { this.Message = value; return this; }
        public Boolean getIsSuccess() { return IsSuccess; }
        public ResponseBase setIsSuccess(Boolean value) { this.IsSuccess = value; return this; }
    }

}

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