POST | /api/documentuploads/registerdocuments |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* Register documents queueud for registration in background
*/
@Api(Description="Register documents queueud for registration in background")
@ApiResponse(Description="All queued documents are linked to a systemtask for background processing", StatusCode=200)
open class AddDocumentsForBackgroundRegistration
{
/**
* List of queued documents to register in background
*/
@ApiMember(Description="List of queued documents to register in background", IsRequired=true)
var Documents:ArrayList<RegisterDocument> = ArrayList<RegisterDocument>()
}
open class RegisterDocument
{
var RegistrationProfileID:UUID? = null
var Values:ArrayList<RegistrationValue> = ArrayList<RegistrationValue>()
var Processes:ArrayList<Process> = ArrayList<Process>()
var DocumentUploadId:String? = null
var DocumentId:UUID? = null
var StandardDocumentID:UUID? = null
var HasUnsavedChangesInDocument:Boolean? = null
var IsOpenedFromNonDMSLocation:Boolean? = null
}
open class RegistrationValue
{
var Key:UUID? = null
var Value:String? = null
var ShadowValue:String? = null
}
open class Process
{
var ID:Int? = null
var Title:String? = null
var Description:String? = null
var Note:String? = null
var Coordinator:String? = null
var Urgent:Boolean? = null
var Transitions:ArrayList<Transition> = ArrayList<Transition>()
}
open class Transition
{
var ID:UUID? = null
var Reason:String? = null
var DelayDate:Date? = null
var DelayReason:String? = null
var UserIDs:ArrayList<Int> = ArrayList<Int>()
var GroupIDs:ArrayList<Int> = ArrayList<Int>()
}
open class AddDocumentsForBackgroundRegistrationResponse
{
var RegisteredDocumentUploads:ArrayList<RegisteredDocumentUpload> = ArrayList<RegisteredDocumentUpload>()
}
open class RegisteredDocumentUpload
{
var DocumentUploadID:Int? = null
var IsSuccess:Boolean? = null
var Message:String? = null
}
Kotlin AddDocumentsForBackgroundRegistration 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 /api/documentuploads/registerdocuments HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Documents:
[
{
Values:
[
{
Value: String,
ShadowValue: String
}
],
Processes:
[
{
ID: 0,
Title: String,
Description: String,
Note: String,
Coordinator: String,
Urgent: False,
Transitions:
[
{
Reason: String,
DelayDate: 0001-01-01,
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/jsv Content-Length: length { RegisteredDocumentUploads: [ { DocumentUploadID: 0, IsSuccess: False, Message: String } ] }