DigiOffice Gateway Web Services

UploadFile

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

import Foundation
import ServiceStack

public class UploadFile : Codable
{
    public var registrationProfileID:String?
    public var navigationPath:String?
    public var fileName:String?
    public var Description:String?
    public var documentUpload:Bool?
    public var metaData:[MetaDataField] = []
    public var documentID:String?
    public var hoofdDocumentID:String?
    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 UploadFileResponse : 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 UploadFile DTOs

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

HTTP + JSV

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

{
	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/jsv
Content-Length: length

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