Protocol
From ToxBank API Wiki
(Difference between revisions)
Line 3: | Line 3: | ||
|REST_op_method=GET | |REST_op_method=GET | ||
|REST_op_uri=/protocol | |REST_op_uri=/protocol | ||
− | |REST_op_params=TBD | + | |REST_op_params=TBD , search parameters to query/filter protocols |
|REST_op_mime_input=none | |REST_op_mime_input=none | ||
|REST_op_result=List of protocols in supported MIME formats | |REST_op_result=List of protocols in supported MIME formats | ||
− | |REST_op_mime_output=text/uri-list, RDF, JSON, XML | + | |REST_op_mime_output=text/uri-list, RDF, JSON, XML |
|REST_op_status=200,400,401,402,403 | |REST_op_status=200,400,401,402,403 | ||
}} | }} |
Revision as of 12:38, 14 September 2011
Description | Retrieves list of protocols, including metadata |
---|---|
Resource | [[]] |
Method | GET |
URI | /protocol |
Parameters | TBD , search parameters to query/filter protocols |
Header Parameters | |
Media Type (input) | none |
Results | List of protocols in supported MIME formats |
Media Type (output) | text/uri-list, RDF, JSON, XML |
Status code | 200,400,401,402,403 |
Description | Uploads a protocol |
---|---|
Resource | [[]] |
Method | POST |
URI | /protocol |
Parameters | TBD, file content in multipart web form, with predefined metadata |
Header Parameters | |
Media Type (input) | multipart web form - application/x-www-form-urlencoded, RDF, JSON |
Results | URI of the new protocol , e.g. /protocol/P123 |
Media Type (output) | text/uri-list |
Status code | 200,400,401,402,403 |
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 |
Facts about ProtocolRDF feed
Acts on | |
Has output media type | text/uri-list, RDF, JSON, XML +, text/uri-list +, application/pdf, etc. + and RDF,JSON,XML + |
Has status code | 200,400,401,402,403 + |