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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/FileExists HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Url":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Exists":false,"Url":"String","FileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","DocumentQueuedForRegistrationID":0}