User
From ToxBank API Wiki
(Difference between revisions)
m (Created page with "TBD (wrapper for OpenAM ?) /user/{obfuscatedid} GET - user details Currently the user details are retrieved via call to OpenAM") |
m |
||
| Line 1: | Line 1: | ||
| − | + | = 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 == | ||
| + | |||
| + | {{REST Operations | ||
| + | |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_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 == | ||
| + | |||
| + | Same as [[API_Protocol:RetrieveList]], but filtered by the user. | ||
| + | {{REST Operations | ||
| + | |REST_op_description=Retrieves list of protocols, including metadata, filtered by the user | ||
| + | |REST_op_method=GET | ||
| + | |REST_op_uri=/user/{obfuscated_id}/protocols | ||
| + | |REST_op_params=TBD , search parameters to query/filter protocols | ||
| + | |REST_header_param=subjectid:SECURITY-TOKEN | ||
| + | |REST_op_mime_input=none | ||
| + | |REST_op_result=List of protocols in supported MIME formats | ||
| + | |REST_op_mime_output=text/uri-list, RDF, JSON, XML | ||
| + | |REST_op_status=200, 400, 401, 402, 403 | ||
| + | }} | ||
| + | |||
| + | == Retrieve My Studies == | ||
| + | |||
| + | Same as [[API_Study:RetrieveList]], but filtered by the user. | ||
| + | {{REST Operations | ||
| + | |REST_op_description=Retrieves list of studies, including metadata, filtered by the user | ||
| + | |REST_op_method=GET | ||
| + | |REST_op_uri=/user/{obfuscated_id}/study | ||
| + | |REST_op_params=TBD , search options to query/filter studies | ||
| + | |REST_header_param=subjectid:SECURITY-TOKEN | ||
| + | |REST_op_mime_input=none | ||
| + | |REST_op_result=List of studies in supported Media Type formats | ||
| + | |REST_op_mime_output=text/uri-list, RDF, JSON, XML | ||
| + | |REST_op_status=200,400,401,402,403 | ||
| + | }} | ||
Revision as of 07:10, 16 September 2011
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 type | multiple formats + and text/uri-list, RDF, JSON, XML + |
| Has status code | 200,202,400,401,402,403 +, 200, 400, 401, 402, 403 + and 200,400,401,402,403 + |
