Versions Compared

Old Version 22

changes.mady.by.user Remo Räber

Saved on

compared with

New Version 23

changes.mady.by.user Susanne Schlegel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

During the deprecation period, both the old and the new data structures ("greeting", see below) will be available in the API, with transparent conversion of the values.
However, you may only use either structure in an a Create / Update request (i.e. do not send a "greeting" along with "gender" and "title" fields as these are mutually exclusive and might partially or fully overwrite each other if used in parallel).

...

We will continue to support the deprecated fields until their scheduled removal. The following translation logic will be applied:

DirectionFieldLogic
From Faces (HTTP GET)gender
  • If a commonTitle is present, it is reported as-is
  • If a sex is set, it is reported (M / F / U / X)
  • Otherwise the field will be set to null
 titleWill be mapped one-to-one from greeting.formalTitle
To Faces (HTTP PATCH / POST)gender
  • If value is a known sex type (M / F / U / X) , apply it as "sex"
    • For F set greeting commonTitle = MS
    • for M set greeting commonTitle = MR
  • If value is a known common title, apply it as such and derive the default sex from it (e.g. MR = Sex "M", MS = Sex "F")
  • Otherwise set Sex = "U" and remove commonTitle. The sent value will not be stored
 titleWill be mapped one-to-one to greeting.formalTitle

API rate limiting

If we monitor excessive API calls over a longer period, we reserve the right to set a rate limiting or to charge for these calls.