Protocol

From ToxBank API Wiki
Revision as of 12:43, 15 September 2011 by Egonw (Talk | contribs)
Jump to: navigation, search

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


Description Retrieves a protocol
Resource [[]]
Method GET
URI /protocol/{id}
Parameters TBD, file content in a supported mime format
Header Parameters
Media Type (input) none
Results URI of the new protocol , e.g. /protocol/P123
Media Type (output) application/pdf, etc.
Status code 200,400,401,402,403


Description Retrieves the protocol metadata
Resource [[]]
Method GET
URI /protocol/{id}/metadata
Parameters TBD, search options to filter the requested metadata fields
Header Parameters
Media Type (input) none?
Results The metadata representation in supported media type
Media Type (output) RDF,JSON,XML
Status code 200,400,401,402,403
[Edit 'Protocol' API ]
Facts about ProtocolRDF feed
Acts on
Has output media typeapplication/pdf, etc.  + and RDF,JSON,XML  +
Has status code200,400,401,402,403  +
Personal tools