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 .xml suffix or ?format=xml

HTTP + XML

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: doapigw.baasbv.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddFileDocumentQueuedForRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <AssignToGroupID>0</AssignToGroupID>
  <AssignToUserID>0</AssignToUserID>
  <Description>String</Description>
  <DocumentInfo>String</DocumentInfo>
  <Note>String</Note>
  <UploadOrigin>String</UploadOrigin>
</AddFileDocumentQueuedForRegistration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentQueuedForRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <DocumentuploadID>0</DocumentuploadID>
</DocumentQueuedForRegistration>