API Protocol:Retrieve

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
m
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
{{REST Operations
 
{{REST Operations
|REST_op_description=Retrieves a protocol
+
|REST_op_description=Retrieves the document, describing the protocol
 
|REST_resource=Protocol
 
|REST_resource=Protocol
 
|REST_op_method=GET
 
|REST_op_method=GET
|REST_op_uri=/protocol/{id}
+
|REST_op_uri=/protocol/{id}/document
|REST_op_params=TBD, file content in a supported mime format
+
|REST_op_params=none
 
|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=Protocol content in one of supported MIME format
 
|REST_op_result=Protocol content in one of supported MIME format
|REST_op_mime_output=application/pdf, etc.
+
|REST_op_mime_output=application/pdf;application/msword
 
|REST_op_status=200,400,401,402,403
 
|REST_op_status=200,400,401,402,403
 
}}
 
}}

Latest revision as of 14:43, 14 December 2011

Description Retrieves the document, describing the protocol
Resource Protocol
Method GET
URI /protocol/{id}/document
Parameters none
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results Protocol content in one of supported MIME format
Media Type (output) application/pdf;application/msword
Status code 200,400,401,402,403
Facts about API Protocol:RetrieveRDF feed
Acts onProtocol  +
Has output media typeapplication/pdf;application/msword  +
Has status code200,400,401,402,403  +
Personal tools