DigiOffice Gateway Web Services

<back to all web services

FileExists

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 FileExistsResponse:
    exists: Optional[bool] = None
    url: Optional[str] = None
    file_i_d: Optional[str] = None
    document_i_d: Optional[str] = None
    document_queued_for_registration_i_d: Optional[int] = None


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

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

<FileExists xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <Url>String</Url>
</FileExists>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FileExistsResponse 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>
  <DocumentQueuedForRegistrationID>0</DocumentQueuedForRegistrationID>
  <Exists>false</Exists>
  <FileID>00000000-0000-0000-0000-000000000000</FileID>
  <Url>String</Url>
</FileExistsResponse>