DigiOffice Gateway Web Services

<back to all web services

GetDocumentFileDetails

Requires Authentication
The following routes are available for this service:
GET/api/documents/{DocumentID}/filedetails
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 DocumentFile:
    name: Optional[str] = None
    extension: Optional[str] = None
    size: Optional[int] = None
    content: Optional[bytes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentFileDetails:
    document_i_d: Optional[str] = None
    include_content: Optional[bool] = None
    document_field_i_d: Optional[str] = None

Python GetDocumentFileDetails 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.

GET /api/documents/{DocumentID}/filedetails HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <Content>AA==</Content>
  <Extension>String</Extension>
  <Name>String</Name>
  <Size>0</Size>
</DocumentFile>