DigiOffice Gateway Web Services

<back to all web services

UpdateDocumentWithFile

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 UpdateDocumentWithFileResponse:
    is_succes: Optional[bool] = None
    file_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDocumentWithFile:
    document_id: Optional[str] = None
    update_storage_system: Optional[bool] = None

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

<UpdateDocumentWithFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <UpdateStorageSystem>false</UpdateStorageSystem>
</UpdateDocumentWithFile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateDocumentWithFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <FileUrl>String</FileUrl>
  <IsSucces>false</IsSucces>
</UpdateDocumentWithFileResponse>