API Protocol:RetrieveTemplates

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
m
 
Line 1: Line 1:
 
{{REST Operations
 
{{REST Operations
|REST_op_description=Retrieves templates, defined for the protocol
+
|REST_op_description=Retrieves the data template, defined for a protocol
 
|REST_resource=Protocol
 
|REST_resource=Protocol
 
|REST_op_method=GET
 
|REST_op_method=GET
 
|REST_op_uri=/protocol/{id}/datatemplate
 
|REST_op_uri=/protocol/{id}/datatemplate
|REST_op_params=TBD, search options to filter the requested templates
+
|REST_op_params=none
 
|REST_header_param=subjectid:SECURITY-TOKEN
 
|REST_header_param=subjectid:SECURITY-TOKEN
|REST_op_mime_input=none?
+
|REST_op_mime_input=none
 
|REST_op_result=The template representation in supported media type
 
|REST_op_result=The template representation in supported media type
|REST_op_mime_output=URI, RDF, JSON, XLS, XML, etc.
+
|REST_op_mime_output=text/uri-list;application/rdf+xml;text/n3;text/csv
 
|REST_op_status=200,400,401,402,403
 
|REST_op_status=200,400,401,402,403
 
}}
 
}}

Latest revision as of 15:35, 14 December 2011

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
Facts about API Protocol:RetrieveTemplatesRDF feed
Acts onProtocol  +
Has output media typetext/uri-list;application/rdf+xml;text/n3;text/csv  +
Has status code200,400,401,402,403  +
Personal tools