DigiOffice Gateway Web Services

<back to all web services

AddFileDocumentQueuedForRegistration

Requires Authentication
The following routes are available for this service:
POST/api/documentuploads
AddFileDocumentQueuedForRegistration Parameters:
NameParameterData TypeRequiredDescription
NotebodystringNo
DescriptionbodystringNo
UploadOriginbodystringNo
AssignToUserIDbodyint?No
AssignToGroupIDbodyint?No
DocumentInfobodystringNo
DocumentQueuedForRegistration Parameters:
NameParameterData TypeRequiredDescription
DocumentuploadIDformintNo

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/documentuploads HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Note: String,
	Description: String,
	UploadOrigin: String,
	AssignToUserID: 0,
	AssignToGroupID: 0,
	DocumentInfo: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DocumentuploadID: 0
}