DigiOffice Gateway Web Services

<back to all web services

AddDocument

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DMS.Operations;
using IDB.API.DMS;
using IDB.Core.Diagnostics.Interfaces;

namespace IDB.API.DMS
{
    public partial class AttachmentMailing
    {
    }

    public partial class Bookmark
    {
        public virtual bool? RemoveLastBreak { get; set; }
        public virtual bool ReplaceOnChange { get; set; }
        public virtual bool IsDynamic { get; set; }
    }

    public enum DocInfoSilentMode
    {
        Off,
        AllowUserInteraction,
        DoNotAllowUserInteraction,
    }

    public partial class Mailings
    {
    }

    [DataContract]
    public partial class MetaDataField
    {
        [DataMember]
        public virtual Guid? ID { get; set; }

        [DataMember]
        public virtual Guid? DocumentVeldID { get; set; }

        [DataMember]
        public virtual string Name { get; set; }

        [DataMember]
        public virtual string Label { get; set; }

        [DataMember]
        public virtual string Datatype { get; set; }

        [DataMember]
        public virtual string PrintLabel { get; set; }

        [DataMember]
        public virtual string Entity { get; set; }

        [DataMember]
        public virtual string PrintValue { get; set; }

        [DataMember]
        public virtual string RegistrationValue { get; set; }

        [DataMember]
        public virtual string SPSiteColumnName { get; set; }

        [DataMember]
        public virtual string ShadowName { get; set; }

        [DataMember]
        public virtual string ShadowDatatype { get; set; }

        [DataMember]
        public virtual string ShadowSPSiteColumnName { get; set; }

        [DataMember]
        public virtual string ShadowSPSiteColumnRegistrationValue { get; set; }

        [DataMember]
        public virtual string ShadowRegistrationValue { get; set; }

        [DataMember]
        public virtual bool IsKeyField { get; set; }

        [DataMember]
        public virtual bool KopierenBijNieuweVersie { get; set; }
    }

}

namespace IDB.API.DMS.Operations
{
    public partial class AddDocument
    {
        public AddDocument()
        {
            MetaData = new List<MetaDataField>{};
            AttachmentsMailings = new List<AttachmentMailing>{};
        }

        public virtual Guid RegistrationProfileID { get; set; }
        public virtual Guid? DocumentID { get; set; }
        public virtual Guid? RootDocumentID { get; set; }
        public virtual int? AssignToUserID { get; set; }
        public virtual int? AssignToGroupID { get; set; }
        public virtual List<MetaDataField> MetaData { get; set; }
        public virtual Mailings Mailings { get; set; }
        public virtual List<AttachmentMailing> AttachmentsMailings { get; set; }
        public virtual Guid? FileID { get; set; }
        public virtual DocInfoSilentMode SilentMode { get; set; }
        public virtual bool updateStorageSystem { get; set; }
        public virtual int? MessageQueueId { get; set; }
    }

    public partial class DocumentResponse
    {
        public DocumentResponse()
        {
            MetaData = new List<MetaDataField>{};
            Bookmarks = new List<Bookmark>{};
            AttachmentsMailings = new List<AttachmentMailing>{};
        }

        public virtual Guid DocumentID { get; set; }
        public virtual string DocumentNr { get; set; }
        public virtual Guid RootDocumentID { get; set; }
        public virtual List<MetaDataField> MetaData { get; set; }
        public virtual List<Bookmark> Bookmarks { get; set; }
        public virtual Mailings Mailings { get; set; }
        public virtual List<AttachmentMailing> AttachmentsMailings { get; set; }
        public virtual IInformationMessages Messages { get; set; }
        public virtual string SourceDocumentPath { get; set; }
        public virtual string DestinationDocumentPath { get; set; }
        public virtual string SharePointContentTypeName { get; set; }
        public virtual bool ZIPAttachments { get; set; }
    }

}

namespace IDB.Core.Diagnostics.Interfaces
{
    public partial interface IInformationMessages
    {
    }

}

C# AddDocument 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/AddDocument HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
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: application/json
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}