DigiOffice Gateway Web Services

<back to all web services

GetDocumentUploadDetails

Requires Authentication
The following routes are available for this service:
GET/api/documentuploads/{ID}
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 DocumentUpload:
    id: Optional[int] = None
    description: Optional[str] = None
    notes: Optional[str] = None
    file_name: Optional[str] = None
    extension: Optional[str] = None
    file_date: Optional[datetime.datetime] = None
    assigned_to: Optional[str] = None
    assigned_to_group: Optional[str] = None
    uploaded_by: Optional[str] = None
    has_preview: Optional[bool] = None


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

Python GetDocumentUploadDetails 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/documentuploads/{ID} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentUpload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <AssignedTo>String</AssignedTo>
  <AssignedToGroup>String</AssignedToGroup>
  <Description>String</Description>
  <Extension>String</Extension>
  <FileDate>0001-01-01T00:00:00</FileDate>
  <FileName>String</FileName>
  <HasPreview>false</HasPreview>
  <ID>0</ID>
  <Notes>String</Notes>
  <UploadedBy>String</UploadedBy>
</DocumentUpload>