DigiOffice Gateway Web Services

<back to all web services

GetUserTranslations

Requires Authentication

// @DataContract
export class Translation implements ITranslation
{
    // @DataMember
    public Key?: string;

    // @DataMember
    public NL?: string;

    // @DataMember
    public EN?: string;

    // @DataMember
    public DE?: string;

    // @DataMember
    public FR?: string;

    // @DataMember
    public C1?: string;

    // @DataMember
    public C2?: string;

    // @DataMember
    public C3?: string;

    // @DataMember
    public C4?: string;

    // @DataMember
    public C5?: string;

    // @DataMember
    public C6?: string;

    public constructor(init?: Partial<Translation>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetTranslationsResponse
{
    // @DataMember
    public Translations?: Translation[];

    // @DataMember
    public PreferredLanguage?: string;

    // @DataMember
    public PreferredLanguageShort?: string;

    public constructor(init?: Partial<GetTranslationsResponse>) { (Object as any).assign(this, init); }
}

export class GetTranslations
{
    public TranslateKeys?: string[];

    public constructor(init?: Partial<GetTranslations>) { (Object as any).assign(this, init); }
}

export class GetUserTranslations extends GetTranslations
{

    public constructor(init?: Partial<GetUserTranslations>) { super(init); (Object as any).assign(this, init); }
}

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

<GetUserTranslations 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>
</GetUserTranslations>
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>