DigiOffice Gateway Web Services

UploadFile

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class UploadFile
{
    var RegistrationProfileID:UUID? = null
    var NavigationPath:String? = null
    var FileName:String? = null
    var Description:String? = null
    var DocumentUpload:Boolean? = null
    var MetaData:ArrayList<MetaDataField> = ArrayList<MetaDataField>()
    var DocumentID:UUID? = null
    var HoofdDocumentID:UUID? = null
    var SubDocumentIDs:ArrayList<UUID> = ArrayList<UUID>()
}

@DataContract
open class MetaDataField
{
    @DataMember
    var ID:UUID? = null

    @DataMember
    var DocumentVeldID:UUID? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var Label:String? = null

    @DataMember
    var Datatype:String? = null

    @DataMember
    var PrintLabel:String? = null

    @DataMember
    var Entity:String? = null

    @DataMember
    var PrintValue:String? = null

    @DataMember
    var RegistrationValue:String? = null

    @DataMember
    var SPSiteColumnName:String? = null

    @DataMember
    var ShadowName:String? = null

    @DataMember
    var ShadowDatatype:String? = null

    @DataMember
    var ShadowSPSiteColumnName:String? = null

    @DataMember
    var ShadowSPSiteColumnRegistrationValue:String? = null

    @DataMember
    var ShadowRegistrationValue:String? = null

    @DataMember
    var IsKeyField:Boolean? = null

    @DataMember
    var KopierenBijNieuweVersie:Boolean? = null
}

@DataContract
open class UploadFileResponse
{
    @DataMember
    var DocumentId:UUID? = null

    @DataMember
    var DocumentUploadId:Int? = null

    @DataMember
    var DocumentNr:String? = null

    @DataMember
    var Messages:InformationMessages? = null
}

open class InformationMessages : ArrayList<InformationMessageBase>(), IInformationMessages
{
}

open class InformationMessageBase : IInformationMessage
{
    var Type:MessageType? = null
    var Summary:String? = null
    var FullMessage:String? = null
    var FieldName:String? = null
    var KeepOpen:Boolean? = null
}

enum class MessageType(val value:Int)
{
    Information(1),
    Warning(2),
    Error(3),
    Success(4),
}

Kotlin UploadFile 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/UploadFile HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UploadFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DMS.Operations">
  <Description>String</Description>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <DocumentUpload>false</DocumentUpload>
  <FileName>String</FileName>
  <HoofdDocumentID>00000000-0000-0000-0000-000000000000</HoofdDocumentID>
  <MetaData 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>
  </MetaData>
  <NavigationPath>String</NavigationPath>
  <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
  <SubDocumentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SubDocumentIDs>
</UploadFile>

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

<UploadFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DMS.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>
</UploadFileResponse>