DigiOffice Gateway Web Services

<back to all web services

GetRetrieveDocNr

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 GetRetrieveDocNr:
    document_id: Optional[str] = None
    email_message_id: Optional[str] = None
    email_message_id_base64: Optional[str] = None


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

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

<GetRetrieveDocNr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DMS.Operations">
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <EmailMessageId>String</EmailMessageId>
  <EmailMessageIdBase64>String</EmailMessageIdBase64>
</GetRetrieveDocNr>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetRetrieveDocNrResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DMS.Operations">
  <DocumentNr>String</DocumentNr>
</GetRetrieveDocNrResponse>