DigiOffice Gateway Web Services

<back to all web services

AddDocumentByEmailMessageId

Requires Authentication
AddDocumentByEmailMessageId Parameters:
NameParameterData TypeRequiredDescription
ItemIdquerystringNo
EwsUrlquerystringNo
TokenquerystringNo
DocumentIdquerystringNo
documentToAddqueryAddDocumentNo
AddDocument Parameters:
NameParameterData TypeRequiredDescription
RegistrationProfileIDformGuidNo
DocumentIDformGuid?No
RootDocumentIDformGuid?No
AssignToUserIDformint?No
AssignToGroupIDformint?No
MetaDataformList<MetaDataField>No
MailingsformMailingsNo
AttachmentsMailingsformList<AttachmentMailing>No
FileIDformGuid?No
SilentModeformDocInfoSilentModeNo
updateStorageSystemformboolNo
MessageQueueIdformint?No
MetaDataField Parameters:
NameParameterData TypeRequiredDescription
IDformGuid?No
DocumentVeldIDformGuid?No
NameformstringNo
LabelformstringNo
DatatypeformstringNo
PrintLabelformstringNo
EntityformstringNo
PrintValueformstringNo
RegistrationValueformstringNo
SPSiteColumnNameformstringNo
ShadowNameformstringNo
ShadowDatatypeformstringNo
ShadowSPSiteColumnNameformstringNo
ShadowSPSiteColumnRegistrationValueformstringNo
ShadowRegistrationValueformstringNo
IsKeyFieldformboolNo
KopierenBijNieuweVersieformboolNo
DocInfoSilentMode Enum:
Off
AllowUserInteraction
DoNotAllowUserInteraction
DocumentResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformGuidNo
DocumentNrformstringNo
RootDocumentIDformGuidNo
MetaDataformList<MetaDataField>No
BookmarksformList<Bookmark>No
MailingsformMailingsNo
AttachmentsMailingsformList<AttachmentMailing>No
MessagesformIInformationMessagesNo
SourceDocumentPathformstringNo
DestinationDocumentPathformstringNo
SharePointContentTypeNameformstringNo
ZIPAttachmentsformboolNo
Bookmark Parameters:
NameParameterData TypeRequiredDescription
RemoveLastBreakformbool?No
ReplaceOnChangeformboolNo
IsDynamicformboolNo

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
}