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
import Foundation
import ServiceStack

/**
* Add a uploadfile with metadata.
*/
// @Api(Description="Add a uploadfile with metadata.")
public class AddUploadFile : Codable
{
    /**
    * Registration profile ID
    */
    // @ApiMember(Description="Registration profile ID", IsRequired=true)
    public var registrationProfileID:String

    /**
    * Registration navigation path
    */
    // @ApiMember(Description="Registration navigation path")
    public var navigationPath:String

    /**
    * File name
    */
    // @ApiMember(Description="File name", IsRequired=true)
    public var fileName:String

    /**
    * File date
    */
    // @ApiMember(Description="File date", IsRequired=true)
    public var fileDate:Date

    /**
    * File content
    */
    // @ApiMember(Description="File content", IsRequired=true)
    public var fileContent:[UInt8] = []

    /**
    * File description
    */
    // @ApiMember(Description="File description", IsRequired=true)
    public var Description:String

    /**
    * Keep document in uploads (false; register immediately)
    */
    // @ApiMember(Description="Keep document in uploads (false; register immediately)")
    public var documentUpload:Bool

    /**
    * Source of the file
    */
    // @ApiMember(Description="Source of the file")
    public var source:String

    /**
    * MetaDataFields
    */
    // @ApiMember(Description="MetaDataFields")
    public var metaDataFields:[MetaDataField]

    /**
    * Document ID
    */
    // @ApiMember(Description="Document ID")
    public var documentID:String?

    /**
    * Main Document ID
    */
    // @ApiMember(Description="Main Document ID")
    public var mainDocumentID:String?

    /**
    * Sub Document IDs
    */
    // @ApiMember(Description="Sub Document IDs")
    public var subDocumentIDs:[String]

    required public init(){}
}

// @DataContract
public class MetaDataField : Codable
{
    // @DataMember
    public var id:String?

    // @DataMember
    public var documentVeldID:String?

    // @DataMember
    public var name:String

    // @DataMember
    public var label:String

    // @DataMember
    public var datatype:String

    // @DataMember
    public var printLabel:String

    // @DataMember
    public var entity:String

    // @DataMember
    public var printValue:String

    // @DataMember
    public var registrationValue:String

    // @DataMember
    public var spSiteColumnName:String

    // @DataMember
    public var shadowName:String

    // @DataMember
    public var shadowDatatype:String

    // @DataMember
    public var shadowSPSiteColumnName:String

    // @DataMember
    public var shadowSPSiteColumnRegistrationValue:String

    // @DataMember
    public var shadowRegistrationValue:String

    // @DataMember
    public var isKeyField:Bool

    // @DataMember
    public var kopierenBijNieuweVersie:Bool

    required public init(){}
}

// @DataContract
public class AddUploadFileResponse : Codable
{
    // @DataMember
    public var documentId:String?

    // @DataMember
    public var documentUploadId:Int?

    // @DataMember
    public var documentNr:String

    // @DataMember
    public var messages:InformationMessages

    required public init(){}
}

public class InformationMessages : List<InformationMessageBase>, IInformationMessages
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class InformationMessageBase : IInformationMessage, Codable
{
    public var type:MessageType
    public var summary:String
    public var fullMessage:String
    public var fieldName:String
    public var keepOpen:Bool

    required public init(){}
}

public enum MessageType : Int, Codable
{
    case Information = 1
    case Warning = 2
    case Error = 3
    case Success = 4
}

Swift 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>