API Protocol:RetrieveList

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
m
Line 1: Line 1:
 
{{REST Operations
 
{{REST Operations
|REST_op_description=Retrieves list of protocols, including metadata
+
|REST_op_description=Retrieves list of protocols
 
|REST_resource=Protocol
 
|REST_resource=Protocol
 
|REST_op_method=GET
 
|REST_op_method=GET
 
|REST_op_uri=/protocol
 
|REST_op_uri=/protocol
|REST_op_params=TBD , search parameters to query/filter protocols
+
|REST_op_params=none, or ?search=name or paging parameters: page, pagesize
 
|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=List of protocols in supported MIME formats
+
|REST_op_result=The protocol representation in supported media type
|REST_op_mime_output=text/uri-list, RDF, JSON, XML
+
|REST_op_mime_output=text/uri-list;application/rdf+xml;text/n3
 
|REST_op_status=200, 400, 401, 402, 403
 
|REST_op_status=200, 400, 401, 402, 403
 
}}
 
}}

Revision as of 14:05, 14 December 2011

Description Retrieves list of protocols
Resource Protocol
Method GET
URI /protocol
Parameters none, or ?search=name or paging parameters: page, pagesize
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results The protocol representation in supported media type
Media Type (output) text/uri-list;application/rdf+xml;text/n3
Status code 200, 400, 401, 402, 403
Facts about API Protocol:RetrieveListRDF feed
Acts onProtocol  +
Has output media typetext/uri-list;application/rdf+xml;text/n3  +
Has status code200, 400, 401, 402, 403  +
Personal tools