DigiOffice Gateway Web Services

UploadFile

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

**UploadFile** Parameters:
Name	Parameter	Data Type	Required
RegistrationProfileID	body	Guid	No
NavigationPath	body	string	No
FileName	body	string	No
Description	body	string	No
DocumentUpload	body	bool	No
MetaData	body	List<MetaDataField>	No
DocumentID	body	Guid?	No
HoofdDocumentID	body	Guid?	No
SubDocumentIDs	body	List<Guid>	No

**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

**UploadFileResponse** 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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","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: application/json
Content-Length: length

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