DigiOffice Gateway Web Services

<back to all web services

UploadFile

Requires Authentication
The following routes are available for this service:
POST/api/DMS/UploadFile
UploadFile Parameters:
NameParameterData TypeRequiredDescription
RegistrationProfileIDbodyGuidNo
NavigationPathbodystringNo
FileNamebodystringNo
FileDatebodyDateTime?No
DescriptionbodystringNo
DocumentUploadbodyboolNo
SourcebodystringNo
MetaDatabodystringNo
DocumentIDbodyGuid?No
HoofdDocumentIDbodyGuid?No
SubDocumentIDsbodyList<Guid>No
UploadFileResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentIdformGuid?No
DocumentUploadIdformint?No
DocumentNrformstringNo
MessagesformInformationMessagesNo
InformationMessageBase Parameters:
NameParameterData TypeRequiredDescription
TypeformMessageTypeNo
SummaryformstringNo
FullMessageformstringNo
FieldNameformstringNo
KeepOpenformboolNo
MessageType Enum:
NameValue
Information1
Warning2
Error3
Success4

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: test-dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NavigationPath: String,
	FileName: String,
	FileDate: 0001-01-01,
	Description: String,
	DocumentUpload: False,
	Source: String,
	MetaData: String,
	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: 
	[
		{
			
		}
	]
}