| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FileName: String,
Month: 0,
Day: 0,
ExternalId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
FileName: String,
Message: String,
IsSuccess: False
}