DigiOffice Gateway Web Services

<back to all web services

AddDocument

Requires Authentication
namespace IDB.API.DMS

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type MetaDataField() = 
        [<DataMember>]
        member val ID:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<DataMember>]
        member val DocumentVeldID:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val Label:String = null with get,set

        [<DataMember>]
        member val Datatype:String = null with get,set

        [<DataMember>]
        member val PrintLabel:String = null with get,set

        [<DataMember>]
        member val Entity:String = null with get,set

        [<DataMember>]
        member val PrintValue:String = null with get,set

        [<DataMember>]
        member val RegistrationValue:String = null with get,set

        [<DataMember>]
        member val SPSiteColumnName:String = null with get,set

        [<DataMember>]
        member val ShadowName:String = null with get,set

        [<DataMember>]
        member val ShadowDatatype:String = null with get,set

        [<DataMember>]
        member val ShadowSPSiteColumnName:String = null with get,set

        [<DataMember>]
        member val ShadowSPSiteColumnRegistrationValue:String = null with get,set

        [<DataMember>]
        member val ShadowRegistrationValue:String = null with get,set

        [<DataMember>]
        member val IsKeyField:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val KopierenBijNieuweVersie:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Bookmark() = 
        member val RemoveLastBreak:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ReplaceOnChange:Boolean = new Boolean() with get,set
        member val IsDynamic:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Mailings() = 
        class end

    [<AllowNullLiteral>]
    type AttachmentMailing() = 
        class end

    [<AllowNullLiteral>]
    type IInformationMessages = 
        interface end

    [<AllowNullLiteral>]
    type DocumentResponse() = 
        member val DocumentID:Guid = new Guid() with get,set
        member val DocumentNr:String = null with get,set
        member val RootDocumentID:Guid = new Guid() with get,set
        member val MetaData:ResizeArray<MetaDataField> = new ResizeArray<MetaDataField>() with get,set
        member val Bookmarks:ResizeArray<Bookmark> = new ResizeArray<Bookmark>() with get,set
        member val Mailings:Mailings = null with get,set
        member val AttachmentsMailings:ResizeArray<AttachmentMailing> = new ResizeArray<AttachmentMailing>() with get,set
        member val Messages:IInformationMessages = null with get,set
        member val SourceDocumentPath:String = null with get,set
        member val DestinationDocumentPath:String = null with get,set
        member val SharePointContentTypeName:String = null with get,set
        member val ZIPAttachments:Boolean = new Boolean() with get,set

    type DocInfoSilentMode =
        | Off = 0
        | AllowUserInteraction = 1
        | DoNotAllowUserInteraction = 2

    [<AllowNullLiteral>]
    type AddDocument() = 
        member val RegistrationProfileID:Guid = new Guid() with get,set
        member val DocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val RootDocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val AssignToUserID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AssignToGroupID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MetaData:ResizeArray<MetaDataField> = new ResizeArray<MetaDataField>() with get,set
        member val Mailings:Mailings = null with get,set
        member val AttachmentsMailings:ResizeArray<AttachmentMailing> = new ResizeArray<AttachmentMailing>() with get,set
        member val FileID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val SilentMode:DocInfoSilentMode = new DocInfoSilentMode() with get,set
        member val updateStorageSystem:Boolean = new Boolean() with get,set
        member val MessageQueueId:Nullable<Int32> = new Nullable<Int32>() with get,set

F# AddDocument DTOs

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

HTTP + CSV

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

POST /csv/reply/AddDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","AssignToUserID":0,"AssignToGroupID":0,"MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Mailings":{},"AttachmentsMailings":[{}],"FileID":"00000000-0000-0000-0000-000000000000","SilentMode":"Off","updateStorageSystem":false,"MessageQueueId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DocumentID":"00000000-0000-0000-0000-000000000000","DocumentNr":"String","RootDocumentID":"00000000-0000-0000-0000-000000000000","MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Bookmarks":[{"RemoveLastBreak":false,"ReplaceOnChange":false,"IsDynamic":false}],"Mailings":{},"AttachmentsMailings":[{}],"Messages":null,"SourceDocumentPath":"String","DestinationDocumentPath":"String","SharePointContentTypeName":"String","ZIPAttachments":false}