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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","NavigationPath":"String","FileName":"String","Description":"String","DocumentUpload":false,"MetaData":[{"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","HoofdDocumentID":"00000000-0000-0000-0000-000000000000","SubDocumentIDs":["00000000-0000-0000-0000-000000000000"]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DocumentId":"00000000-0000-0000-0000-000000000000","DocumentUploadId":0,"DocumentNr":"String","Messages":[{}]}