DigiOffice Gateway Web Services

<back to all web services

RegisterDocument

Requires Authentication
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 RegisterDocumentResponse() = 
        member val IsSucces:Boolean = new Boolean() with get,set
        member val DocumentId:Guid = new Guid() with get,set
        member val ErrorMessages:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Ooxml:String = null with get,set
        ///<summary>
        ///Is it a corporate identity document?
        ///</summary>
        [<ApiMember(Description="Is it a corporate identity document?", IsRequired=true)>]
        member val IsCorporateIdentity:Boolean = new Boolean() with get,set

        member val DocumentVariables:IDictionary<String, String> = null 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

F# RegisterDocument DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/RegisterDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"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: application/json
Content-Length: length

{"IsSucces":false,"DocumentId":"00000000-0000-0000-0000-000000000000","ErrorMessages":["String"],"Ooxml":"String","IsCorporateIdentity":false,"DocumentVariables":null}