User

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
(My alerts)
(Retrieve user details)
Line 32: Line 32:
 
== Retrieve user details ==
 
== Retrieve user details ==
  
{{REST Operations
+
{{HasOperation |id=User:Details}}
|REST_op_description=Retrieve user details
+
|REST_op_method=GET
+
|REST_op_uri=/user/{obfuscated_id}
+
|REST_op_params=TBD, may be used  to filter the retrieved info
+
|REST_header_param=subjectid:SECURITY-TOKEN
+
|REST_op_mime_input=none
+
|REST_op_result=content
+
|REST_op_mime_output=multiple formats
+
|REST_op_status=200,202,400,401,402,403
+
}}
+
  
 
== Retrieve My Protocols ==
 
== Retrieve My Protocols ==

Revision as of 12:55, 7 October 2011

User


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 users

Description Retrieve list of users
Resource User
Method GET
URI /user
Parameters none, or ?search=prefix_of_firstname_or_lastname or paging parameters: page, pagesize or ?username=USERNAME
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results The project representation in supported media type
Media Type (output) application/rdf+xml;text/n3;text/uri-list
Status code 200,400,401,402,403

Links: Page, Edit with form



cURL example

curl -X GET /user?consortium=ToxBank

Retrieve user details

Description Retrieve user details
Resource User
Method GET
URI /user/{obfuscated_id}
Parameters none
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results The user representation in supported media type
Media Type (output) application/rdf+xml;text/n3;text/uri-list
Status code 200,400,401,402,403

Links: Page, Edit with form



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 User
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

Links: Page, Edit with form



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 User
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

Links: Page, Edit with form



My alerts

Description Retrieves list of alerts, filtered by the user
Resource User
Method GET
URI /user/{obfuscated_id}/alerts
Parameters TBD , search options to query/filter alerts
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results List of alerts in supported Media Type formats
Media Type (output) text/uri-list;application/rdf+xml;text/n3
Status code 200,400,401,402,403

Links: Page, Edit with form


Personal tools