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
DescriptionbodystringNo
DocumentUploadbodyboolNo
MetaDatabodyList<MetaDataField>No
DocumentIDbodyGuid?No
HoofdDocumentIDbodyGuid?No
SubDocumentIDsbodyList<Guid>No
MetaDataField Parameters:
NameParameterData TypeRequiredDescription
IDformGuid?No
DocumentVeldIDformGuid?No
NameformstringNo
LabelformstringNo
DatatypeformstringNo
PrintLabelformstringNo
EntityformstringNo
PrintValueformstringNo
RegistrationValueformstringNo
SPSiteColumnNameformstringNo
ShadowNameformstringNo
ShadowDatatypeformstringNo
ShadowSPSiteColumnNameformstringNo
ShadowSPSiteColumnRegistrationValueformstringNo
ShadowRegistrationValueformstringNo
IsKeyFieldformboolNo
KopierenBijNieuweVersieformboolNo
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 .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":[{}]}