admin-ch / CovidCertificate-Apidoc

API documentation for the integration of primary systems with the machine to machine API
73 stars 7 forks source link

Problem in the readme api definition #20

Open lewinernst opened 3 years ago

lewinernst commented 3 years ago

When implementing the api i first created my jsons based on the structure in the readme, but had some problems after because i ended up with a non-conforming structure. Based on the readme, I assumed the API would expect a PersonalDataobject with surname, given name, birth date and language and a ConfigurationData object with the otp. Checking the api-definition in code however revealed that the structure is different: All of these are included directly on the top-level of the payload except for the names which are included as two parts of a name object. Perhaps a hint could be included that the Headings don't correspond to objects?