| 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 .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 HTTP/1.1
Host: initiation-pen.sirva.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FileName: String,
ExternalId: String,
RequestStream: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
FileName: String,
DownloadLink: String,
ListLink: String,
DaysToLive: 0,
Message: String,
IsSuccess: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}