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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ID: 0,
	Description: String,
	Notes: String,
	FileName: String,
	Extension: String,
	FileDate: 0001-01-01,
	AssignedTo: String,
	AssignedToGroup: String,
	UploadedBy: String,
	HasPreview: False
}