Protocol
From ToxBank API Wiki
(Difference between revisions)
Line 9: | Line 9: | ||
|REST_op_status=200,400,401,402,403 | |REST_op_status=200,400,401,402,403 | ||
}} | }} | ||
+ | |||
+ | {{:API_Protocol:RetrieveList}} | ||
+ | |||
{{REST Operations | {{REST Operations | ||
|REST_op_description=Uploads a protocol | |REST_op_description=Uploads a protocol |
Revision as of 11:52, 15 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 | 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 |
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 + |