| POST | /api/documentuploads/registerdocuments |
|---|
"use strict";
export class RegisteredDocumentUpload {
/** @param {{DocumentUploadID?:number,IsSuccess?:boolean,Message?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DocumentUploadID;
/** @type {boolean} */
IsSuccess;
/** @type {string} */
Message;
}
export class AddDocumentsForBackgroundRegistrationResponse {
/** @param {{RegisteredDocumentUploads?:RegisteredDocumentUpload[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {RegisteredDocumentUpload[]} */
RegisteredDocumentUploads;
}
export class RegistrationValue {
/** @param {{Key?:string,Value?:string,ShadowValue?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Value;
/** @type {string} */
ShadowValue;
}
export class Transition {
/** @param {{ID?:string,Reason?:string,DelayDate?:string,DelayReason?:string,UserIDs?:number[],GroupIDs?:number[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ID;
/** @type {string} */
Reason;
/** @type {?string} */
DelayDate;
/** @type {string} */
DelayReason;
/** @type {number[]} */
UserIDs;
/** @type {number[]} */
GroupIDs;
}
export class Process {
/** @param {{ID?:number,Title?:string,Description?:string,Note?:string,Coordinator?:string,Urgent?:boolean,Transitions?:Transition[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ID;
/** @type {string} */
Title;
/** @type {string} */
Description;
/** @type {string} */
Note;
/** @type {string} */
Coordinator;
/** @type {boolean} */
Urgent;
/** @type {Transition[]} */
Transitions;
}
export class RegisterDocument {
/** @param {{RegistrationProfileID?:string,Values?:RegistrationValue[],Processes?:Process[],DocumentUploadId?:string,DocumentId?:string,StandardDocumentID?:string,HasUnsavedChangesInDocument?:boolean,IsOpenedFromNonDMSLocation?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RegistrationProfileID;
/** @type {RegistrationValue[]} */
Values;
/** @type {Process[]} */
Processes;
/** @type {string} */
DocumentUploadId;
/** @type {?string} */
DocumentId;
/** @type {?string} */
StandardDocumentID;
/** @type {?boolean} */
HasUnsavedChangesInDocument;
/** @type {?boolean} */
IsOpenedFromNonDMSLocation;
}
export class AddDocumentsForBackgroundRegistration {
/** @param {{Documents?:RegisterDocument[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {RegisterDocument[]}
* @description List of queued documents to register in background */
Documents = [];
}
JavaScript AddDocumentsForBackgroundRegistration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documentuploads/registerdocuments HTTP/1.1
Host: test-do-services.klokgroep.nl
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Documents":[{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","DelayReason":"String","UserIDs":[0],"GroupIDs":[0]}]}],"DocumentUploadId":"String","DocumentId":"00000000-0000-0000-0000-000000000000","StandardDocumentID":"00000000-0000-0000-0000-000000000000","HasUnsavedChangesInDocument":false,"IsOpenedFromNonDMSLocation":false}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"RegisteredDocumentUploads":[{"DocumentUploadID":0,"IsSuccess":false,"Message":"String"}]}