Protocol

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
(Upload a new Protocol)
Line 5: Line 5:
 
{{:API_Protocol:Upload}}
 
{{:API_Protocol:Upload}}
  
{{REST Operations
+
= Retrieve a single Protocol =
|REST_op_description=Retrieves a protocol
+
{{:API_Protocol:Retrieve}}
|REST_op_method=GET
+
 
|REST_op_uri=/protocol/{id}
+
= Retrieve Metadata of a single Protocol =
|REST_op_params=TBD, file content in a supported mime format
+
{{:API_Protocol:RetrieveMetadata}}
|REST_op_mime_input=none
+
 
|REST_op_result=URI of the new protocol , e.g. /protocol/P123
+
|REST_op_mime_output=application/pdf, etc.
+
|REST_op_status=200,400,401,402,403
+
}}
+
{{REST Operations
+
|REST_op_description=Retrieves the protocol metadata
+
|REST_op_method=GET
+
|REST_op_uri=/protocol/{id}/metadata
+
|REST_op_params=TBD, search options to filter the requested metadata fields
+
|REST_op_mime_input=none?
+
|REST_op_result=The metadata representation in supported media type
+
|REST_op_mime_output=RDF,JSON,XML
+
|REST_op_status=200,400,401,402,403
+
}}
+
 
[[http://api.toxbank.net/index.php/Special:FormEdit/REST_OperationsForm/API_Protocol Edit 'Protocol' API ]]
 
[[http://api.toxbank.net/index.php/Special:FormEdit/REST_OperationsForm/API_Protocol Edit 'Protocol' API ]]

Revision as of 12:45, 15 September 2011

Contents

Retrieve the List of Protocols

Description Retrieves list of protocols
Resource Protocol
Method GET
URI /protocol
Parameters none, or ?search=name or paging parameters: page, pagesize or modefiedSince=UNIX-TIME-STAMP-in-ms
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


Upload a new Protocol

Description Uploads a protocol
Resource Protocol
Method POST
URI /protocol
Parameters (see cURL example)
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) multipart/form-data
Results Task representation in supported MIME formats
Media Type (output) text/uri-list;application/rdf+xml;text/n3
Status code 200,202,400,401,402,403,500


Retrieve a single Protocol

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


Retrieve Metadata of a single Protocol

Description Retrieves the protocol metadata
Resource Protocol
Method GET
URI /protocol/{id}
Parameters none
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results The metadata representation in supported media type
Media Type (output) text/uri-list;application/rdf+xml;text/n3
Status code 200,400,401,402,403
[Edit 'Protocol' API ]
Personal tools