| POST | /api/DMS/AddUploadFile |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.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.DTO.Document.Operations
{
///<summary>
///Add a uploadfile with metadata.
///</summary>
[Api(Description="Add a uploadfile with metadata.")]
public partial class AddUploadFile
{
///<summary>
///Registration profile ID
///</summary>
[ApiMember(Description="Registration profile ID", IsRequired=true)]
public virtual Guid RegistrationProfileID { get; set; }
///<summary>
///Registration navigation path
///</summary>
[ApiMember(Description="Registration navigation path")]
public virtual string NavigationPath { get; set; }
///<summary>
///File name
///</summary>
[ApiMember(Description="File name", IsRequired=true)]
public virtual string FileName { get; set; }
///<summary>
///File date
///</summary>
[ApiMember(Description="File date", IsRequired=true)]
public virtual DateTime FileDate { get; set; }
///<summary>
///File content
///</summary>
[ApiMember(Description="File content", IsRequired=true)]
public virtual byte[] FileContent { get; set; } = [];
///<summary>
///File description
///</summary>
[ApiMember(Description="File description", IsRequired=true)]
public virtual string Description { get; set; }
///<summary>
///Keep document in uploads (false; register immediately)
///</summary>
[ApiMember(Description="Keep document in uploads (false; register immediately)")]
public virtual bool DocumentUpload { get; set; }
///<summary>
///Source of the file
///</summary>
[ApiMember(Description="Source of the file")]
public virtual string Source { get; set; }
///<summary>
///MetaDataFields
///</summary>
[ApiMember(Description="MetaDataFields")]
public virtual List<MetaDataField> MetaDataFields { get; set; }
///<summary>
///Document ID
///</summary>
[ApiMember(Description="Document ID")]
public virtual Guid? DocumentID { get; set; }
///<summary>
///Main Document ID
///</summary>
[ApiMember(Description="Main Document ID")]
public virtual Guid? MainDocumentID { get; set; }
///<summary>
///Sub Document IDs
///</summary>
[ApiMember(Description="Sub Document IDs")]
public virtual List<Guid> SubDocumentIDs { get; set; }
}
[DataContract]
public partial class AddUploadFileResponse
{
[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
{
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/DMS/AddUploadFile HTTP/1.1
Host: dogw.klokgroep.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
NavigationPath: String,
FileName: String,
FileDate: 0001-01-01,
FileContent: AA==,
Description: String,
DocumentUpload: False,
Source: String,
MetaDataFields:
[
{
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,
MainDocumentID: 00000000-0000-0000-0000-000000000000,
SubDocumentIDs:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
DocumentId: 00000000-0000-0000-0000-000000000000,
DocumentUploadId: 0,
DocumentNr: String,
Messages:
[
{
}
]
}