DigiOffice Gateway Web Services

<back to all web services

AddUploadFile

Add a uploadfile with metadata.

Requires Authentication
The following routes are available for this service:
POST/api/DMS/AddUploadFile
namespace IDB.API.DMS

open System
open System.IO
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

    ///<summary>
    ///Add a uploadfile with metadata.
    ///</summary>
    [<Api(Description="Add a uploadfile with metadata.")>]
    [<AllowNullLiteral>]
    type AddUploadFile() = 
        ///<summary>
        ///Registration profile ID
        ///</summary>
        [<ApiMember(Description="Registration profile ID", IsRequired=true)>]
        member val RegistrationProfileID:Guid = new Guid() with get,set

        ///<summary>
        ///Registration navigation path
        ///</summary>
        [<ApiMember(Description="Registration navigation path")>]
        member val NavigationPath:String = null with get,set

        ///<summary>
        ///File name
        ///</summary>
        [<ApiMember(Description="File name", IsRequired=true)>]
        member val FileName:String = null with get,set

        ///<summary>
        ///File date
        ///</summary>
        [<ApiMember(Description="File date", IsRequired=true)>]
        member val FileDate:DateTime = new DateTime() with get,set

        ///<summary>
        ///File content
        ///</summary>
        [<ApiMember(Description="File content", IsRequired=true)>]
        member val FileContent:Byte[] = null with get,set

        ///<summary>
        ///File description
        ///</summary>
        [<ApiMember(Description="File description", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Keep document in uploads (false; register immediately)
        ///</summary>
        [<ApiMember(Description="Keep document in uploads (false; register immediately)")>]
        member val DocumentUpload:Boolean = new Boolean() with get,set

        ///<summary>
        ///Source of the file
        ///</summary>
        [<ApiMember(Description="Source of the file")>]
        member val Source:String = null with get,set

        ///<summary>
        ///MetaDataFields
        ///</summary>
        [<ApiMember(Description="MetaDataFields")>]
        member val MetaDataFields:ResizeArray<MetaDataField> = null with get,set

        ///<summary>
        ///Document ID
        ///</summary>
        [<ApiMember(Description="Document ID")>]
        member val DocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Main Document ID
        ///</summary>
        [<ApiMember(Description="Main Document ID")>]
        member val MainDocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Sub Document IDs
        ///</summary>
        [<ApiMember(Description="Sub Document IDs")>]
        member val SubDocumentIDs:ResizeArray<Guid> = null with get,set

    type MessageType =
        | Information = 1
        | Warning = 2
        | Error = 3
        | Success = 4

    [<AllowNullLiteral>]
    type InformationMessageBase() = 
        member val Type:MessageType = new MessageType() with get,set
        member val Summary:String = null with get,set
        member val FullMessage:String = null with get,set
        member val FieldName:String = null with get,set
        member val KeepOpen:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type InformationMessages() = 
        inherit ResizeArray<InformationMessageBase>()

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

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

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

        [<DataMember>]
        member val Messages:InformationMessages = null with get,set

F# AddUploadFile DTOs

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

HTTP + XML

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: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddUploadFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <Description>String</Description>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <DocumentUpload>false</DocumentUpload>
  <FileContent>AA==</FileContent>
  <FileDate>0001-01-01T00:00:00</FileDate>
  <FileName>String</FileName>
  <MainDocumentID>00000000-0000-0000-0000-000000000000</MainDocumentID>
  <MetaDataFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DMS">
    <d2p1:MetaDataField>
      <d2p1:Datatype>String</d2p1:Datatype>
      <d2p1:DocumentVeldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentVeldID>
      <d2p1:Entity>String</d2p1:Entity>
      <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
      <d2p1:IsKeyField>false</d2p1:IsKeyField>
      <d2p1:KopierenBijNieuweVersie>false</d2p1:KopierenBijNieuweVersie>
      <d2p1:Label>String</d2p1:Label>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PrintLabel>String</d2p1:PrintLabel>
      <d2p1:PrintValue>String</d2p1:PrintValue>
      <d2p1:RegistrationValue>String</d2p1:RegistrationValue>
      <d2p1:SPSiteColumnName>String</d2p1:SPSiteColumnName>
      <d2p1:ShadowDatatype>String</d2p1:ShadowDatatype>
      <d2p1:ShadowName>String</d2p1:ShadowName>
      <d2p1:ShadowRegistrationValue>String</d2p1:ShadowRegistrationValue>
      <d2p1:ShadowSPSiteColumnName>String</d2p1:ShadowSPSiteColumnName>
      <d2p1:ShadowSPSiteColumnRegistrationValue>String</d2p1:ShadowSPSiteColumnRegistrationValue>
    </d2p1:MetaDataField>
  </MetaDataFields>
  <NavigationPath>String</NavigationPath>
  <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
  <Source>String</Source>
  <SubDocumentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SubDocumentIDs>
</AddUploadFile>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddUploadFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <DocumentNr>String</DocumentNr>
  <DocumentUploadId>0</DocumentUploadId>
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Core.Diagnostics.Interfaces">
    <d2p1:InformationMessageBase i:nil="true" />
  </Messages>
</AddUploadFileResponse>