User

From ToxBank API Wiki
Revision as of 07:10, 16 September 2011 by Nina (Talk | contribs)
Jump to: navigation, search

Contents

OpenAM

Currently, User details can be retrieved by requesting OpenAM attributes, given a valid token.

Java library

http://vedina.github.com/opentox-aa-cli/

Ruby library

...

REST interface =

Would be useful to expose users via URIs, to be able to link various objects to the authors/owners. The user name should not be in the URI,an approach similar to Google+ can be adopted

This is my user URI at G+
https://plus.google.com/106434626815784595027
And here are my posts.
https://plus.google.com/106434626815784595027/posts
The content you see will differ, depending on whether you are logged in G+,
and whether you are allowed to see particular post.

Retrieve user details

Description Retrieve user details
Resource [[]]
Method GET
URI /user/{obfuscated_id}
Parameters TBD, may be used to filter the retrieved info
Header Parameters
Media Type (input) none
Results content
Media Type (output) multiple formats
Status code 200,202,400,401,402,403


Retrieve My Protocols

Same as API_Protocol:RetrieveList, but filtered by the user.

Description Retrieves list of protocols, including metadata, filtered by the user
Resource [[]]
Method GET
URI /user/{obfuscated_id}/protocols
Parameters TBD , search parameters to query/filter protocols
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results List of protocols in supported MIME formats
Media Type (output) text/uri-list, RDF, JSON, XML
Status code 200, 400, 401, 402, 403


Retrieve My Studies

Same as API_Study:RetrieveList, but filtered by the user.

Description Retrieves list of studies, including metadata, filtered by the user
Resource [[]]
Method GET
URI /user/{obfuscated_id}/study
Parameters TBD , search options to query/filter studies
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results List of studies in supported Media Type formats
Media Type (output) text/uri-list, RDF, JSON, XML
Status code 200,400,401,402,403
Facts about UserRDF feed
Acts on
Has output media typemultiple formats  + and text/uri-list, RDF, JSON, XML  +
Has status code200,202,400,401,402,403  +, 200, 400, 401, 402, 403  + and 200,400,401,402,403  +
Personal tools