User:RetrieveList

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "{{REST Operations |REST_op_description=Retrieve list of users |REST_resource=User |REST_op_method=GET |REST_op_uri=/user |REST_op_params=TBD, may be used to filter the retrieved...")
 
m
 
(3 intermediate revisions by one user not shown)
Line 4: Line 4:
 
|REST_op_method=GET
 
|REST_op_method=GET
 
|REST_op_uri=/user
 
|REST_op_uri=/user
|REST_op_params=TBD, may be used  to filter the retrieved info ,e.g. ?project=ToxBank&org=DC
+
|REST_op_params=none, or ?search=prefix_of_firstname_or_lastname or paging parameters: page, pagesize  or ?username=USERNAME
 
|REST_header_param=subjectid:SECURITY-TOKEN
 
|REST_header_param=subjectid:SECURITY-TOKEN
 
|REST_op_mime_input=none
 
|REST_op_mime_input=none
|REST_op_result=content
+
|REST_op_result=The project representation in supported media type
|REST_op_mime_output=multiple formats
+
|REST_op_mime_output=application/rdf+xml;text/n3;text/uri-list
|REST_op_status=200,202,400,401,402,403
+
|REST_op_status=200,400,401,402,403
 +
|REST_op_example=curl -X GET -H 'Accept:text/uri-list' -H 'subjectid:TOKEN' http://toxbanktest1.opentox.org:8080/toxbank/user
 
}}
 
}}

Latest revision as of 13:03, 17 January 2012

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
Facts about RetrieveListRDF feed
Acts onUser  +
Has output media typeapplication/rdf+xml;text/n3;text/uri-list  +
Has status code200,400,401,402,403  +
Personal tools