Protocol
From ToxBank API Wiki
(Difference between revisions)
(→Upload a new Protocol) |
|||
| Line 1: | Line 1: | ||
| + | {{REST_resource | ||
| + | }} | ||
| + | |||
= Retrieve the List of Protocols = | = Retrieve the List of Protocols = | ||
{{:API_Protocol:RetrieveList}} | {{:API_Protocol:RetrieveList}} | ||
Revision as of 12:50, 15 September 2011
| Protocol |
|---|
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 |
