| POST | /api/documentuploads/registerdocuments |
|---|
namespace IDB.API.DTO.Document.Operations
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type RegisteredDocumentUpload() =
member val DocumentUploadID:Int32 = new Int32() with get,set
member val IsSuccess:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
[<AllowNullLiteral>]
type AddDocumentsForBackgroundRegistrationResponse() =
member val RegisteredDocumentUploads:ResizeArray<RegisteredDocumentUpload> = new ResizeArray<RegisteredDocumentUpload>() with get,set
[<AllowNullLiteral>]
type RegistrationValue() =
member val Key:Guid = new Guid() with get,set
member val Value:String = null with get,set
member val ShadowValue:String = null with get,set
[<AllowNullLiteral>]
type Transition() =
member val ID:Guid = new Guid() with get,set
member val Reason:String = null with get,set
member val DelayDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DelayReason:String = null with get,set
member val UserIDs:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
member val GroupIDs:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
[<AllowNullLiteral>]
type Process() =
member val ID:Int32 = new Int32() with get,set
member val Title:String = null with get,set
member val Description:String = null with get,set
member val Note:String = null with get,set
member val Coordinator:String = null with get,set
member val Urgent:Boolean = new Boolean() with get,set
member val Transitions:ResizeArray<Transition> = new ResizeArray<Transition>() with get,set
[<AllowNullLiteral>]
type RegisterDocument() =
member val RegistrationProfileID:Guid = new Guid() with get,set
member val Values:ResizeArray<RegistrationValue> = new ResizeArray<RegistrationValue>() with get,set
member val Processes:ResizeArray<Process> = new ResizeArray<Process>() with get,set
member val DocumentUploadId:String = null with get,set
member val DocumentId:Nullable<Guid> = new Nullable<Guid>() with get,set
member val StandardDocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
member val HasUnsavedChangesInDocument:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val IsOpenedFromNonDMSLocation:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Register documents queueud for registration in background
///</summary>
[<Api(Description="Register documents queueud for registration in background")>]
[<ApiResponse(Description="All queued documents are linked to a systemtask for background processing", StatusCode=200)>]
[<AllowNullLiteral>]
type AddDocumentsForBackgroundRegistration() =
///<summary>
///List of queued documents to register in background
///</summary>
[<ApiMember(Description="List of queued documents to register in background", IsRequired=true)>]
member val Documents:ResizeArray<RegisterDocument> = new ResizeArray<RegisterDocument>() with get,set
F# 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
}
]
}