DigiOffice Gateway Web Services

<back to all web services

AddFileDocumentQueuedForRegistration

Requires Authentication
The following routes are available for this service:
POST/api/documentuploads
"use strict";
export class DocumentQueuedForRegistration {
    /** @param {{DocumentuploadID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentuploadID;
}
export class AddFileDocumentQueuedForRegistration {
    /** @param {{Note?:string,Description?:string,UploadOrigin?:string,AssignToUserID?:number,AssignToGroupID?:number,DocumentInfo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Note;
    /** @type {string} */
    Description;
    /** @type {string} */
    UploadOrigin;
    /** @type {?number} */
    AssignToUserID;
    /** @type {?number} */
    AssignToGroupID;
    /** @type {string} */
    DocumentInfo;
}

JavaScript AddFileDocumentQueuedForRegistration DTOs

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: test-dogw.klokgroep.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>