DigiOffice Gateway Web Services

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
POST/api/DMS/UploadFile
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

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

    @DataMember
    open var DocumentUploadId:Int? = null

    @DataMember
    open var DocumentNr:String? = null

    @DataMember
    open var Messages:InformationMessages? = null
}

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

open class InformationMessageBase : IInformationMessage
{
    override var Type:MessageType? = null
    override var Summary:String? = null
    override var FullMessage:String? = null
    override var FieldName:String? = null
    override 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: test-dogw.klokgroep.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>
  <FileDate>0001-01-01T00:00:00</FileDate>
  <FileName>String</FileName>
  <HoofdDocumentID>00000000-0000-0000-0000-000000000000</HoofdDocumentID>
  <MetaData>String</MetaData>
  <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>
</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>