Difference between revisions of "Development:Prana Breath API/Collections:Tests"

From Olekdia Wiki
Line 1: Line 1:
 
<code>tests</code>, or <code>health_tests</code> - collection that gives you access to all trainings in the app.<br/>
 
<code>tests</code>, or <code>health_tests</code> - collection that gives you access to all trainings in the app.<br/>
 
__TOC__
 
  
 
__TOC__
 
__TOC__
Line 7: Line 5:
 
<div class="api-table long-code">
 
<div class="api-table long-code">
 
== Prefix ==
 
== Prefix ==
It could be used with next prefixes:
 
 
* <code>pranabreath://</code>
 
* <code>pranabreath://</code>
With next prefixes, only <code>trainings</code> collection could be used. Also both prefix and collection are case-sensitive:
 
 
* <code><nowiki>https://olekdia.com/pranabreath/</nowiki></code>
 
* <code><nowiki>https://olekdia.com/pranabreath/</nowiki></code>
* <code><nowiki>https://pranabreath.page.link/?link=https://olekdia.com/pranabreath/trainings/</nowiki></code>
+
* <code><nowiki>https://pranabreath.page.link/?link=https://olekdia.com/pranabreath/</nowiki></code>
  
 
== Syntax ==
 
== Syntax ==
* <code>pranabreath://trainings/item?cmd=[Command]</code> - Case-insensitive.  
+
* <code>pranabreath://tests/item?cmd=[Command]</code> - Case-insensitive.  
* <code>pranabreath://Trainings/item?[Parameter]=[Value]</code>
+
* <code><nowiki>https://olekdia.com/pranabreath/tests?cmd=[Command]&[Parameter]=[Value]</nowiki></code> - Case-sensitive.
* <code>pranabreath://trainings/item?cmd=[Command]&[Parameter1]=[Value1]&[Parameter2]=[Value2]</code>
 
* <code><nowiki>https://olekdia.com/pranabreath/trainings?cmd=[Command]&[Parameter]=[Value]</nowiki></code> - Case-sensitive.
 
  
 
== Commands ==
 
== Commands ==
Line 27: Line 21:
 
|  
 
|  
 
==='''list'''===
 
==='''list'''===
| Returns training list. Currently it is only used in console for retrieving training list.
+
| Returns test list. Currently it is only used in console for retrieving health test list.
* <code>pranabreath://trainings?cmd=list</code>  
+
* <code>pranabreath://tests?cmd=list</code>  
 
<pre>
 
<pre>
pos id public_id name
+
id name
1 1        Clear mind
+
-1 shtange
2 2        Relax
+
-2 genchi
3 3        Calming
+
-3 buteyko
4 4        Power
+
-4 heart_rate
4  5  5        Harmony
+
-5 blood_circulation
5   6  6        Anti-stress
 
6  7  7        Anti-appetite
 
7  8  8        Cigarette replace
 
8  9  11        Bhastrika
 
 
</pre>
 
</pre>
* <code>pranabreath://trainings</code> - It is a default command when only ''collection'' is defined without an ''item'', so if we omit the ''command'' it will return the same result.
+
* <code>pranabreath://tests</code> - It is a default command when only ''collection'' is defined without an ''item'', so if we omit the ''command'' it will return the same result.
 
|-
 
|-
 
|  
 
|  

Revision as of 11:14, 1 February 2019

tests, or health_tests - collection that gives you access to all trainings in the app.

Prefix

  • pranabreath://
  • https://olekdia.com/pranabreath/
  • https://pranabreath.page.link/?link=https://olekdia.com/pranabreath/

Syntax

  • pranabreath://tests/item?cmd=[Command] - Case-insensitive.
  • https://olekdia.com/pranabreath/tests?cmd=[Command]&[Parameter]=[Value] - Case-sensitive.

Commands

Command Description

list

Returns test list. Currently it is only used in console for retrieving health test list.
  • pranabreath://tests?cmd=list
id name
-1 shtange
-2 genchi
-3 buteyko
-4 heart_rate
-5 blood_circulation
  • pranabreath://tests - It is a default command when only collection is defined without an item, so if we omit the command it will return the same result.

select

Select the specified training. Commands import, create, start have despite its own effects have also select effect.
  • pranabreath://trainings/Harmony?cmd=select - Select Harmony training.
  • pranabreath://trainings/Harmony - It is default command when item is specified, so it will have the same impact that above example.