| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<AddDocumentsForBackgroundRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
<Documents>
<RegisterDocument>
<DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
<DocumentUploadId>String</DocumentUploadId>
<HasUnsavedChangesInDocument>false</HasUnsavedChangesInDocument>
<IsOpenedFromNonDMSLocation>false</IsOpenedFromNonDMSLocation>
<Processes xmlns:d4p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
<d4p1:Process>
<d4p1:Coordinator>String</d4p1:Coordinator>
<d4p1:Description>String</d4p1:Description>
<d4p1:ID>0</d4p1:ID>
<d4p1:Note>String</d4p1:Note>
<d4p1:Title>String</d4p1:Title>
<d4p1:Transitions>
<d4p1:Transition>
<d4p1:DelayDate>0001-01-01T00:00:00</d4p1:DelayDate>
<d4p1:DelayReason>String</d4p1:DelayReason>
<d4p1:GroupIDs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>0</d8p1:int>
</d4p1:GroupIDs>
<d4p1:ID>00000000-0000-0000-0000-000000000000</d4p1:ID>
<d4p1:Reason>String</d4p1:Reason>
<d4p1:UserIDs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>0</d8p1:int>
</d4p1:UserIDs>
</d4p1:Transition>
</d4p1:Transitions>
<d4p1:Urgent>false</d4p1:Urgent>
</d4p1:Process>
</Processes>
<RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
<StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
<Values xmlns:d4p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
<d4p1:RegistrationValue>
<d4p1:Key>00000000-0000-0000-0000-000000000000</d4p1:Key>
<d4p1:ShadowValue>String</d4p1:ShadowValue>
<d4p1:Value>String</d4p1:Value>
</d4p1:RegistrationValue>
</Values>
</RegisterDocument>
</Documents>
</AddDocumentsForBackgroundRegistration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddDocumentsForBackgroundRegistrationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
<RegisteredDocumentUploads>
<RegisteredDocumentUpload>
<DocumentUploadID>0</DocumentUploadID>
<IsSuccess>false</IsSuccess>
<Message>String</Message>
</RegisteredDocumentUpload>
</RegisteredDocumentUploads>
</AddDocumentsForBackgroundRegistrationResponse>