DigiOffice Gateway Web Services

<back to all web services

GetTemporaryLinkDetails

The following routes are available for this service:
GET/api/temporarylinkdetails/{DocumentID}
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 TemporaryLinkDetailsResponse:
    title: Optional[str] = None
    message: Optional[str] = None
    sub_message: Optional[str] = None
    number_of_attachments: Optional[int] = None
    total_size_in_bytes: Optional[int] = None
    is_valid: Optional[bool] = None


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

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

<TemporaryLinkDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DMS.Operations">
  <IsValid>false</IsValid>
  <Message>String</Message>
  <NumberOfAttachments>0</NumberOfAttachments>
  <SubMessage>String</SubMessage>
  <Title>String</Title>
  <TotalSizeInBytes>0</TotalSizeInBytes>
</TemporaryLinkDetailsResponse>