Client_Initiations

<back to all web services

DocumentUploadRequest

Requires Authentication
The following routes are available for this service:
POST/documents
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="Returned if a client is not authorized to upload a receipt", StatusCode=401)
    // @ApiResponse(Description="Returned if the validation failed for the input expense receipt", StatusCode=412)
    // @ApiResponse(Description="Returned if the corresponding expense report was not found", StatusCode=404)
    // @ApiResponse(Description="Returned if the call to the expense service failed", StatusCode=400)
    public static class DocumentUploadRequest implements IPost
    {
        /**
        * FileName
        */
        @ApiMember(Description="FileName", IsRequired=true, ParameterType="path")
        public String FileName = null;

        /**
        * ExternalID
        */
        @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
        public String ExternalId = null;

        /**
        * RequestStream needs to be base64 file content
        */
        @ApiMember(Description="RequestStream needs to be base64 file content")
        public String RequestStream = null;
        
        public String getFileName() { return FileName; }
        public DocumentUploadRequest setFileName(String value) { this.FileName = value; return this; }
        public String getExternalId() { return ExternalId; }
        public DocumentUploadRequest setExternalId(String value) { this.ExternalId = value; return this; }
        public String getRequestStream() { return RequestStream; }
        public DocumentUploadRequest setRequestStream(String value) { this.RequestStream = value; return this; }
    }

    public static class DocumentUploadResponse
    {
        public String FileName = null;
        public String DownloadLink = null;
        public String ListLink = null;
        public Integer DaysToLive = null;
        public String Message = null;
        public Boolean IsSuccess = null;
        public ResponseStatus ResponseStatus = null;
        
        public String getFileName() { return FileName; }
        public DocumentUploadResponse setFileName(String value) { this.FileName = value; return this; }
        public String getDownloadLink() { return DownloadLink; }
        public DocumentUploadResponse setDownloadLink(String value) { this.DownloadLink = value; return this; }
        public String getListLink() { return ListLink; }
        public DocumentUploadResponse setListLink(String value) { this.ListLink = value; return this; }
        public Integer getDaysToLive() { return DaysToLive; }
        public DocumentUploadResponse setDaysToLive(Integer value) { this.DaysToLive = value; return this; }
        public String getMessage() { return Message; }
        public DocumentUploadResponse setMessage(String value) { this.Message = value; return this; }
        public Boolean getIsSuccess() { return IsSuccess; }
        public DocumentUploadResponse setIsSuccess(Boolean value) { this.IsSuccess = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DocumentUploadResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java DocumentUploadRequest 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 HTTP/1.1 
Host: initiation-test.sirva.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DocumentUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <ExternalId>String</ExternalId>
  <FileName>String</FileName>
  <RequestStream>String</RequestStream>
</DocumentUploadRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <DaysToLive>0</DaysToLive>
  <DownloadLink>String</DownloadLink>
  <FileName>String</FileName>
  <IsSuccess>false</IsSuccess>
  <ListLink>String</ListLink>
  <Message>String</Message>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DocumentUploadResponse>