DigiOffice API Services Services

AddUploadFile

Add a uploadfile with metadata.

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

**AddUploadFile** Parameters:
Name	Parameter	Data Type	Required	Description
RegistrationProfileID	body	Guid	Yes	Registration profile ID
NavigationPath	body	string	No	Registration navigation path
FileName	body	string	Yes	File name
FileDate	body	DateTime	Yes	File date
FileContent	body	byte[]	Yes	File content
Description	body	string	Yes	File description
DocumentUpload	body	bool	No	Keep document in uploads (false; register immediately)
Source	body	string	No	Source of the file
MetaDataFields	body	List<MetaDataField>	No	MetaDataFields
DocumentID	body	Guid?	No	Document ID
MainDocumentID	body	Guid?	No	Main Document ID
SubDocumentIDs	body	List<Guid>	No	Sub Document IDs

**MetaDataField** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid?	No
DocumentVeldID	form	Guid?	No
Name	form	string	No
Label	form	string	No
Datatype	form	string	No
PrintLabel	form	string	No
Entity	form	string	No
PrintValue	form	string	No
RegistrationValue	form	string	No
SPSiteColumnName	form	string	No
ShadowName	form	string	No
ShadowDatatype	form	string	No
ShadowSPSiteColumnName	form	string	No
ShadowSPSiteColumnRegistrationValue	form	string	No
ShadowRegistrationValue	form	string	No
IsKeyField	form	bool	No
KopierenBijNieuweVersie	form	bool	No

**AddUploadFileResponse** Parameters:
Name	Parameter	Data Type	Required
DocumentId	form	Guid?	No
DocumentUploadId	form	int?	No
DocumentNr	form	string	No
Messages	form	InformationMessages	No

**InformationMessageBase** Parameters:
Name	Parameter	Data Type	Required
Type	form	MessageType	No
Summary	form	string	No
FullMessage	form	string	No
FieldName	form	string	No
KeepOpen	form	bool	No

**MessageType** Enum:
Name	Value
Information	1
Warning	2
Error	3
Success	4

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/AddUploadFile HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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