DigiOffice Gateway Web Services

<back to all web services

AddDocumentByEmailMessageId

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


open class AddDocumentByEmailMessageId
{
    var ItemId:String? = null
    var EwsUrl:String? = null
    var Token:String? = null
    var DocumentId:String? = null
    var documentToAdd:AddDocument? = null
}

open class AddDocument
{
    var RegistrationProfileID:UUID? = null
    var DocumentID:UUID? = null
    var RootDocumentID:UUID? = null
    var AssignToUserID:Int? = null
    var AssignToGroupID:Int? = null
    var MetaData:ArrayList<MetaDataField> = ArrayList<MetaDataField>()
    var Mailings:Mailings? = null
    var AttachmentsMailings:ArrayList<AttachmentMailing> = ArrayList<AttachmentMailing>()
    var FileID:UUID? = null
    var SilentMode:DocInfoSilentMode? = null
    var updateStorageSystem:Boolean? = null
    var MessageQueueId:Int? = null
}

@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
}

open class Mailings
{
}

open class AttachmentMailing
{
}

enum class DocInfoSilentMode
{
    Off,
    AllowUserInteraction,
    DoNotAllowUserInteraction,
}

open class DocumentResponse
{
    var DocumentID:UUID? = null
    var DocumentNr:String? = null
    var RootDocumentID:UUID? = null
    var MetaData:ArrayList<MetaDataField> = ArrayList<MetaDataField>()
    var Bookmarks:ArrayList<Bookmark> = ArrayList<Bookmark>()
    var Mailings:Mailings? = null
    var AttachmentsMailings:ArrayList<AttachmentMailing> = ArrayList<AttachmentMailing>()
    var Messages:IInformationMessages? = null
    var SourceDocumentPath:String? = null
    var DestinationDocumentPath:String? = null
    var SharePointContentTypeName:String? = null
    var ZIPAttachments:Boolean? = null
}

open class Bookmark
{
    var RemoveLastBreak:Boolean? = null
    var ReplaceOnChange:Boolean? = null
    var IsDynamic:Boolean? = null
}

open interface IInformationMessages
{
}

Kotlin AddDocumentByEmailMessageId 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 /jsv/reply/AddDocumentByEmailMessageId HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ItemId: String,
	EwsUrl: String,
	Token: String,
	DocumentId: String,
	documentToAdd: 
	{
		DocumentID: 00000000-0000-0000-0000-000000000000,
		RootDocumentID: 00000000-0000-0000-0000-000000000000,
		AssignToUserID: 0,
		AssignToGroupID: 0,
		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
			}
		],
		Mailings: {},
		AttachmentsMailings: 
		[
			{
				
			}
		],
		FileID: 00000000-0000-0000-0000-000000000000,
		SilentMode: Off,
		updateStorageSystem: False,
		MessageQueueId: 0
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DocumentNr: String,
	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
		}
	],
	Bookmarks: 
	[
		{
			RemoveLastBreak: False,
			ReplaceOnChange: False,
			IsDynamic: False
		}
	],
	Mailings: {},
	AttachmentsMailings: 
	[
		{
			
		}
	],
	SourceDocumentPath: String,
	DestinationDocumentPath: String,
	SharePointContentTypeName: String,
	ZIPAttachments: False
}