Client_Initiations

DocumentUploadRequest

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

"use strict";
export class DocumentUploadResponse {
    /** @param {{FileName?:string,DownloadLink?:string,ListLink?:string,DaysToLive?:number,Message?:string,IsSuccess?:boolean,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FileName;
    /** @type {string} */
    DownloadLink;
    /** @type {string} */
    ListLink;
    /** @type {number} */
    DaysToLive;
    /** @type {string} */
    Message;
    /** @type {boolean} */
    IsSuccess;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DocumentUploadRequest {
    /** @param {{FileName?:string,ExternalId?:string,RequestStream?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description FileName */
    FileName;
    /**
     * @type {string}
     * @description ExternalID */
    ExternalId;
    /**
     * @type {string}
     * @description RequestStream needs to be base64 file content */
    RequestStream;
}

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