DigiOffice Gateway Web Services

<back to all web services

AddDocumentQueuedForRegistrationWithDocumentInfo

Requires Authentication
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentQueuedForRegistrationResponse:
    document_queued_for_registration_i_d: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddDocumentQueuedForRegistrationWithDocumentInfo:
    file_i_d: Optional[str] = None
    description: Optional[str] = None
    note: Optional[str] = None
    upload_origin: Optional[str] = None
    assign_to_user_i_d: Optional[int] = None
    assign_to_group_i_d: Optional[int] = None
    document_info: Optional[str] = None

Python AddDocumentQueuedForRegistrationWithDocumentInfo 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 /xml/reply/AddDocumentQueuedForRegistrationWithDocumentInfo HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<DocumentQueuedForRegistrationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DMS.Operations">
  <DocumentQueuedForRegistrationID>0</DocumentQueuedForRegistrationID>
</DocumentQueuedForRegistrationResponse>