Inkonsistente Dokumentation

Discussions

Ask a Question
Back to All

Inkonsistente Dokumentation

(edited)

Hallo liebes Team!

Ich schreibe eine Papershift Integration für ein Terminplanungssystem und stoße in der Dokumentation öfter auf widersprüchliche Aussagen.

  1. Es ist nirgends angegeben, wie man bei Usern oder anderen Elementen explizit eine external_id festlegt, ein Update mit
    {
    "api_key": "...",
    "user": {
    "id": 1,
    "external_id": "abc"
    }
    }
    gibt zurück: "Did not find user with external ID 'abc' within authorized enterprise".
    (Der API-Key ist korrekt aktiviert und funktioniert auch sonst)
    Man sollte ja davon ausgehen können, dass die externe ID ersetzt/aktualisiert wird, wenn die normale ID angegeben ist.

  2. Die Beispiele in der Dokumentation sind teilweise inkonsistent, so enthält das request für Update User folgendes:
    "data_profiles": {
    "birthday": "1980-06-20",
    "desc": "Sample description"
    }
    Das response enthält:
    "data_profiles": {
    "birthday": {
    "label": "Geburtstag",
    "value": "1980-06-20"
    }
    }
    Sollte intern dabei JSON merge/patch (rfc7396) verwendet werden, so wäre diese Notation falsch. (https://tools.ietf.org/html/rfc7396)

Ansonsten ein großes Lob! Die Software funktioniert wirklich gut und ist übersichtlich.

Eine kurze Antwort wäre hilfreich :)

Vielen Dank!

D. Marcinkowski