| POST | /api/DMS/UploadFile |
|---|
"use strict";
export class UploadFile {
/** @param {{RegistrationProfileID?:string,NavigationPath?:string,FileName?:string,FileDate?:string,Description?:string,DocumentUpload?:boolean,Source?:string,MetaData?:string,DocumentID?:string,HoofdDocumentID?:string,SubDocumentIDs?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RegistrationProfileID;
/** @type {string} */
NavigationPath;
/** @type {string} */
FileName;
/** @type {?string} */
FileDate;
/** @type {string} */
Description;
/** @type {boolean} */
DocumentUpload;
/** @type {string} */
Source;
/** @type {string} */
MetaData;
/** @type {?string} */
DocumentID;
/** @type {?string} */
HoofdDocumentID;
/** @type {string[]} */
SubDocumentIDs;
}
/** @typedef {number} */
export var MessageType;
(function (MessageType) {
MessageType[MessageType["Information"] = 1] = "Information"
MessageType[MessageType["Warning"] = 2] = "Warning"
MessageType[MessageType["Error"] = 3] = "Error"
MessageType[MessageType["Success"] = 4] = "Success"
})(MessageType || (MessageType = {}));
export class InformationMessageBase {
/** @param {{Type?:MessageType,Summary?:string,FullMessage?:string,FieldName?:string,KeepOpen?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {MessageType} */
Type;
/** @type {string} */
Summary;
/** @type {string} */
FullMessage;
/** @type {string} */
FieldName;
/** @type {boolean} */
KeepOpen;
}
export class InformationMessages extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class UploadFileResponse {
/** @param {{DocumentId?:string,DocumentUploadId?:number,DocumentNr?:string,Messages?:InformationMessages}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
DocumentId;
/** @type {?number} */
DocumentUploadId;
/** @type {string} */
DocumentNr;
/** @type {InformationMessages} */
Messages;
}
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 /api/DMS/UploadFile HTTP/1.1
Host: dogw.klokgroep.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
NavigationPath: String,
FileName: String,
FileDate: 0001-01-01,
Description: String,
DocumentUpload: False,
Source: String,
MetaData: String,
DocumentID: 00000000-0000-0000-0000-000000000000,
HoofdDocumentID: 00000000-0000-0000-0000-000000000000,
SubDocumentIDs:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
DocumentId: 00000000-0000-0000-0000-000000000000,
DocumentUploadId: 0,
DocumentNr: String,
Messages:
[
{
}
]
}