DigiOffice Gateway Web Services

GetTranslations

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 Translation(ITranslation):
    key: Optional[str] = None
    nl: Optional[str] = None
    en: Optional[str] = None
    de: Optional[str] = None
    fr: Optional[str] = None
    c1: Optional[str] = None
    c2: Optional[str] = None
    c3: Optional[str] = None
    c4: Optional[str] = None
    c5: Optional[str] = None
    c6: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTranslationsResponse:
    translations: Optional[List[Translation]] = None
    preferred_language: Optional[str] = None
    preferred_language_short: Optional[str] = None


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

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

<GetTranslations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Globalization">
  <TranslateKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TranslateKeys>
</GetTranslations>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTranslationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Globalization">
  <PreferredLanguage>String</PreferredLanguage>
  <PreferredLanguageShort>String</PreferredLanguageShort>
  <Translations>
    <Translation>
      <C1>String</C1>
      <C2>String</C2>
      <C3>String</C3>
      <C4>String</C4>
      <C5>String</C5>
      <C6>String</C6>
      <DE>String</DE>
      <EN>String</EN>
      <FR>String</FR>
      <Key>String</Key>
      <NL>String</NL>
    </Translation>
  </Translations>
</GetTranslationsResponse>