Protocol

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
m (→Upload a new Protocol)
m
Line 2: Line 2:
 
}}
 
}}
  
−
= Retrieve the List of Protocols =
+
= Protocol =
 +
 
 +
=== [http://www.w3.org/DesignIssues/Notation3 N3] representation of a Protocol ===
 +
 
 +
tb:Protocol_9
 +
      a      tb:Protocol ;
 +
      tb:hasAbstract "This is protocol abstract"^^xsd:string ;
 +
      tb:hasAuthor tb:OliviaSanger ;
 +
      tb:hasKeyword ""^^xsd:string ;
 +
      tb:hasOwner tb:ORG5 ;
 +
      tb:hasTemplate tb:Template_12 ;
 +
      tb:isSummarySearchable "true"^^xsd:boolean ;
 +
      tb:project tb:DETECTIVE ;
 +
      tb:versionInfo "123"^^xsd:string.
 +
 
 +
tb:ORG5
 +
      a      tb:Organization .
 +
 
 +
tb:DETECTIVE
 +
      a      tb:Project .
 +
 
 +
tb:OliviaSanger
 +
      a      tb:User .
 +
 +
 
 +
== Retrieve the List of Protocols ==
 
{{:API_Protocol:RetrieveList}}
 
{{:API_Protocol:RetrieveList}}
  
−
= Upload a new Protocol =
+
== Upload a new Protocol ==
 
{{:API_Protocol:Upload}}
 
{{:API_Protocol:Upload}}
  
−
= Upload a new Protocol version =
+
== Upload a new Protocol version ==
 
{{:API_Protocol:UploadVersion}}
 
{{:API_Protocol:UploadVersion}}
  
−
= Retrieve a single Protocol =
+
== Retrieve a single Protocol ==
 
{{:API_Protocol:Retrieve}}
 
{{:API_Protocol:Retrieve}}
  
−
= Retrieve Metadata of a single Protocol =
+
== Retrieve Metadata of a single Protocol ==
 
{{:API_Protocol:RetrieveMetadata}}
 
{{:API_Protocol:RetrieveMetadata}}
  
−
= Retrieve versions of a single Protocol =
+
= Protocol versions =
 +
 
 +
== Retrieve versions of a single Protocol ==
 
{{:API_Protocol:RetrieveVersions}}
 
{{:API_Protocol:RetrieveVersions}}
 +
 +
=Protocol templates =
 +
 +
=== [http://www.w3.org/DesignIssues/Notation3 N3] representation of a Template===
 +
 +
tb:Template_12
 +
      a      tb:Template .
  
 
= Retrieve data templates, defined for a Protocol =
 
= Retrieve data templates, defined for a Protocol =

Revision as of 18:57, 15 September 2011

Protocol


Contents

Protocol

N3 representation of a Protocol

tb:Protocol_9 

     a       tb:Protocol ;
     tb:hasAbstract "This is protocol abstract"^^xsd:string ;
     tb:hasAuthor tb:OliviaSanger ;
     tb:hasKeyword ""^^xsd:string ;
     tb:hasOwner tb:ORG5 ;
     tb:hasTemplate tb:Template_12 ;
     tb:isSummarySearchable "true"^^xsd:boolean ;
     tb:project tb:DETECTIVE ;
     tb:versionInfo "123"^^xsd:string.

tb:ORG5 

     a       tb:Organization .

tb:DETECTIVE 

     a       tb:Project .

tb:OliviaSanger 

     a       tb:User .

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


Upload a new Protocol version

Description Uploads a newprotocol version
Resource Protocol
Method POST
URI /protocol/{id}/versions
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


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


Protocol versions

Retrieve versions of a single Protocol

Description Retrieves the protocol versions
Resource Protocol
Method GET
URI /protocol/{id}/versions
Parameters none, or ?search=name or paging parameters: page, pagesize
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results The protocol URI or other supported representation
Media Type (output) text/uri-list;application/rdf+xml;text/n3
Status code 200,400,401,402,403


Protocol templates

N3 representation of a Template

tb:Template_12 

     a       tb:Template .

Retrieve data templates, defined for a Protocol

Description Retrieves the data template, defined for a protocol
Resource Protocol
Method GET
URI /protocol/{id}/datatemplate
Parameters none
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none
Results The template representation in supported media type
Media Type (output) text/uri-list;application/rdf+xml;text/n3;text/csv
Status code 200,400,401,402,403


Create data template for a Protocol

Description Uploads a template, to be assigned to a protocol
Resource Protocol
Method POST
URI /protocol/{id}/datatemplate
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 data template

Description Retrieves a protocol template
Resource Protocol
Method GET
URI /protocol/{id}/datatemplate/{id}
Parameters none?
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input) none?
Results The template representation in supported media type
Media Type (output) RDF,JSON,XML
Status code 200,400,401,402,403
Retrieved from "http://api.toxbank.net/index.php/Protocol"
Personal tools