DigiOffice Gateway Web Services

UploadFile

The following routes are available for this service:
POST	/api/DMS/UploadFile

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.Diagnostics;
using IDB.Core.Diagnostics.Interfaces;
using IDB.Core.Diagnostics;

namespace IDB.API.DMS
{
    [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 UploadFile
    {
        public UploadFile()
        {
            MetaData = new List<MetaDataField>{};
            SubDocumentIDs = new List<Guid>{};
        }

        public virtual Guid RegistrationProfileID { get; set; }
        public virtual string NavigationPath { get; set; }
        public virtual string FileName { get; set; }
        public virtual string Description { get; set; }
        public virtual bool DocumentUpload { get; set; }
        public virtual List<MetaDataField> MetaData { get; set; }
        public virtual Guid? DocumentID { get; set; }
        public virtual Guid? HoofdDocumentID { get; set; }
        public virtual List<Guid> SubDocumentIDs { get; set; }
    }

    [DataContract]
    public partial class UploadFileResponse
    {
        [DataMember]
        public virtual Guid? DocumentId { get; set; }

        [DataMember]
        public virtual int? DocumentUploadId { get; set; }

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

        [DataMember]
        public virtual InformationMessages Messages { get; set; }
    }

}

namespace IDB.Core.Diagnostics
{
    public enum MessageType
    {
        Information = 1,
        Warning = 2,
        Error = 3,
        Success = 4,
    }

}

namespace IDB.Core.Diagnostics.Interfaces
{
    public partial class InformationMessageBase
        : IInformationMessage
    {
        public virtual MessageType Type { get; set; }
        public virtual string Summary { get; set; }
        public virtual string FullMessage { get; set; }
        public virtual string FieldName { get; set; }
        public virtual bool KeepOpen { get; set; }
    }

}

namespace IDB.Diagnostics
{
    public partial class InformationMessages
        : List<InformationMessageBase>, IInformationMessages
    {
    }

}

C# UploadFile 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 /api/DMS/UploadFile HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","NavigationPath":"String","FileName":"String","Description":"String","DocumentUpload":false,"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}],"DocumentID":"00000000-0000-0000-0000-000000000000","HoofdDocumentID":"00000000-0000-0000-0000-000000000000","SubDocumentIDs":["00000000-0000-0000-0000-000000000000"]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DocumentId":"00000000-0000-0000-0000-000000000000","DocumentUploadId":0,"DocumentNr":"String","Messages":[{}]}