| POST, PUT | /documents/download |
|---|
"use strict";
export class DocumentRequestBase {
/** @param {{ExternalId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description ExternalID */
ExternalId;
}
export class ClientDownloadRequest extends DocumentRequestBase {
/** @param {{FileName?:string,Month?:number,Day?:number,ExternalId?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
FileName;
/**
* @type {number}
* @description Month */
Month;
/**
* @type {number}
* @description Day */
Day;
}
export class ResponseBase {
/** @param {{Message?:string,IsSuccess?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Message;
/** @type {boolean} */
IsSuccess;
}
export class ClientDownloadResponse extends ResponseBase {
/** @param {{FileName?:string,Stream?:string,Message?:string,IsSuccess?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
FileName;
/** @type {string} */
Stream;
}
JavaScript ClientDownloadRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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-test.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>