Protocol
From ToxBank API Wiki
(Difference between revisions)
(Created page with "{{REST Operations |REST_op_description=Retrieves list of protocols, including metadata |REST_op_method=GET |REST_op_uri=/protocol |REST_op_params=TBD |REST_op_mime_input=TBD |RES...") |
|||
| Line 4: | Line 4: | ||
|REST_op_uri=/protocol | |REST_op_uri=/protocol | ||
|REST_op_params=TBD | |REST_op_params=TBD | ||
| − | |REST_op_mime_input= | + | |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 ? | ||
| Line 17: | Line 17: | ||
|REST_op_result=URI of the new protocol , e.g. /protocol/P123 | |REST_op_result=URI of the new protocol , e.g. /protocol/P123 | ||
|REST_op_mime_output=text/uri-list | |REST_op_mime_output=text/uri-list | ||
| + | |REST_op_status=200,400 | ||
| + | }} | ||
| + | {{REST Operations | ||
| + | |REST_op_description=Retrieves a protocol | ||
| + | |REST_op_method=GET | ||
| + | |REST_op_uri=/protocol/{id} | ||
| + | |REST_op_params=TBD, file content in a supported mime format | ||
| + | |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 | ||
| + | }} | ||
| + | {{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=URI of the new protocol , e.g. /protocol/P123 | ||
| + | |REST_op_mime_output=RDF,JSON,XML | ||
|REST_op_status=200,400 | |REST_op_status=200,400 | ||
}} | }} | ||
Revision as of 12:12, 14 September 2011
| Description | Retrieves list of protocols, including metadata |
|---|---|
| Resource | [[]] |
| Method | GET |
| URI | /protocol |
| Parameters | TBD |
| 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 |
| 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) | 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 |
| 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 |
| 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 | URI of the new protocol , e.g. /protocol/P123 |
| Media Type (output) | RDF,JSON,XML |
| Status code | 200,400 |
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 + |
