API: add support for private notes in XML

Issue #395 open
Robert Jäschke created an issue

Private notes of publication posts should be returned in XML or be accessible via links + XML. The same holds in principle for extra URLS of publication posts.

Comments (5)

  1. Former user Account Deleted

    Commented by cschenk: Adding these features to the XML like so: --- [...] <post [...]> <bibtex [...]> <privnote>My note...</privnote> <extraurl href="..."> <extraurl href="..."> [...] </bibtex> </post> [...] --- could add a performance penalty because we would have to do a lot more queries (at least two in this case) to fetch this extra information.

    Instead of adding this information to the "bibtex" element for the common post queries (like "/posts" or "/users/[username]/posts"), I suggest adding separate URLs where this extra information can be retrieved. What about this:

    • /users/[username]/posts/[resourceHash]/privnote
    • /users/[username]/posts/[resourceHash]/extraurls with a XML-Schema like the one above; just with the corresponding "privnote" and "extraurl" attributes. This way we would have a distinct location for POST/PUT/DELETE, too.
  2. Robert Jäschke reporter

    Indeed a good idea. In principle there is no neccessity to include this already in the post lists, since an application using the API could easily retrieve this information on demand. Since there is no hurry to implement this feature, we have time to further discuss it.

  3. Log in to comment