Ignore:
Timestamp:
Mar 30, 2012, 3:35:57 PM (10 years ago)
Author:
work@…
Message:
  • implemented getSamplesForAssay api call
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/grails-app/views/api/index.gsp

    r2197 r2199  
    6363    <li><a href="#getSubjectsForStudy">getSubjectsForStudy</a> - fetch all subjects in a given study</li>
    6464    <li><a href="#getAssaysForStudy">getAssaysForStudy</a> - fetch all assays in a given study</li>
     65    <li><a href="#getSamplesForAssay">getSamplesForAssay</a> - fetch all samples in a given assay</li>
    6566    <li><a href="#getAssayData">getAssayData</a> - fetch all measurement data for a given assay</li>
    6667
     
    279280</p>
    280281
    281 <a name="getAssayData"></a>
    282 <h1>getAssayData</h1>
    283 <h3>url: <g:createLink controller="api" action="getAssayData" absolute="true" /></h3>
    284 <p>
    285     Returns the measurement data for a particular assay
     282<a name="getSamplesForAssay"></a>
     283<h1>getSamplesForAssay</h1>
     284<h3>url: <g:createLink controller="api" action="getSamplesForAssay" absolute="true" /></h3>
     285<p>
     286    Returns the samples data for a particular assay
    286287
    287288<h2>Request parameters</h2>
     
    323324<h2>example reply</h2>
    324325<blockquote>
     326    {
     327    "count":
     328    11,
     329    "samples":
     330    [
     331    {
     332    "Remarks":
     333    null,
     334    "Sample measured volume":
     335    null,
     336    "Text on vial":
     337    "T58.66620961739546",
     338    "material":
     339    "blood plasma",
     340    "name":
     341    "7_A",
     342    "token":
     343    "c705668a-81c4-4d80-83df-96bb477aeb0b"
     344    },
     345    {
     346    "Remarks":
     347    null,
     348    "Sample measured volume":
     349    null,
     350    "Text on vial":
     351    "T39.7483280873287",
     352    "material":
     353    "blood plasma",
     354    "name":
     355    "9_A",
     356    "token":
     357    "d81bdda8-4684-45b9-b254-1ec4756cfc71"
     358    },
     359    {
     360    "Remarks":
     361    null,
     362    "Sample measured volume":
     363    null,
     364    "Text on vial":
     365    "T43.20628871191769",
     366    "material":
     367    "blood plasma",
     368    "name":
     369    "2_A",
     370    "token":
     371    "2f501b55-ffdd-4bf2-a598-dcf24d3fac63"
     372    },
     373    {
     374    "Remarks":
     375    null,
     376    "Sample measured volume":
     377    null,
     378    "Text on vial":
     379    "T88.40760089710538",
     380    "material":
     381    "blood plasma",
     382    "name":
     383    "8_A",
     384    "token":
     385    "f908ae2a-3df7-4eb7-be2a-0b8859c20bfc"
     386    },
     387    {
     388    "Remarks":
     389    null,
     390    "Sample measured volume":
     391    null,
     392    "Text on vial":
     393    "T58.14619508995611",
     394    "material":
     395    "blood plasma",
     396    "name":
     397    "11_A",
     398    "token":
     399    "6763cff4-8113-4614-85b9-ef98fb34beba"
     400    },
     401    {
     402    "Remarks":
     403    null,
     404    "Sample measured volume":
     405    null,
     406    "Text on vial":
     407    "T71.86067212685215",
     408    "material":
     409    "blood plasma",
     410    "name":
     411    "6_A",
     412    "token":
     413    "5a339aaa-9bb6-4a0a-9ce7-4c42ceaf5771"
     414    },
     415    {
     416    "Remarks":
     417    null,
     418    "Sample measured volume":
     419    null,
     420    "Text on vial":
     421    "T2.395117860298579",
     422    "material":
     423    "blood plasma",
     424    "name":
     425    "3_A",
     426    "token":
     427    "a9e73abe-aed3-4c43-8fe7-a6b3dfe6e2ed"
     428    },
     429    {
     430    "Remarks":
     431    null,
     432    "Sample measured volume":
     433    null,
     434    "Text on vial":
     435    "T98.99437236833568",
     436    "material":
     437    "blood plasma",
     438    "name":
     439    "10_A",
     440    "token":
     441    "3e63a493-c69d-4cd4-ba23-eeafe962b17f"
     442    },
     443    {
     444    "Remarks":
     445    null,
     446    "Sample measured volume":
     447    null,
     448    "Text on vial":
     449    "T25.420102086098005",
     450    "material":
     451    "blood plasma",
     452    "name":
     453    "4_A",
     454    "token":
     455    "34d5611b-7407-489a-b25a-00ad2b0d8789"
     456    },
     457    {
     458    "Remarks":
     459    null,
     460    "Sample measured volume":
     461    null,
     462    "Text on vial":
     463    "T69.55369597806298",
     464    "material":
     465    "blood plasma",
     466    "name":
     467    "1_A",
     468    "token":
     469    "5c9dce07-ca4d-4bcb-8ac3-c8488bd7247a"
     470    },
     471    {
     472    "Remarks":
     473    null,
     474    "Sample measured volume":
     475    null,
     476    "Text on vial":
     477    "T50.41146383561054",
     478    "material":
     479    "blood plasma",
     480    "name":
     481    "5_A",
     482    "token":
     483    "21a07d33-6d95-46f9-a80d-cd58d7e140d0"
     484    }
     485    ]
     486    }
     487</blockquote>
     488</p>
     489
     490<a name="getAssayData"></a>
     491<h1>getAssayData</h1>
     492<h3>url: <g:createLink controller="api" action="getAssayData" absolute="true" /></h3>
     493<p>
     494    Returns the measurement data for a particular assay
     495
     496<h2>Request parameters</h2>
     497<table>
     498    <thead>
     499    <th>argument</th>
     500    <th>type</th>
     501    <th>length</th>
     502    <th>description</th>
     503    <th>example</th>
     504    <th>required</th>
     505    </thead>
     506    <tr>
     507        <td>deviceID</td>
     508        <td>string</td>
     509        <td>36 (max)</td>
     510        <td>a unique ID of the client device / application performing the call</td>
     511        <td>9ae87836-d38d-4b86-be6a-eff93f2b049a</td>
     512        <td>yes</td>
     513    </tr>
     514    <tr>
     515        <td>validation</td>
     516        <td>string</td>
     517        <td>-</td>
     518        <td><a href="http://www.miraclesalad.com/webtools/md5.php" target="_new">md5sum</a>( token + sequence + shared secret )</td>
     519        <td>9ae87836d38d4b86be6aeff93f2b049a</td>
     520        <td>yes</td>
     521    </tr>
     522    <tr>
     523        <td>assayToken</td>
     524        <td>string</td>
     525        <td>255</td>
     526        <td>assay token (see getAssays)</td>
     527        <td>b6e0c6f4-d8db-4a43-91fa-a157d2d492f0</td>
     528        <td>yes</td>
     529    </tr>
     530</table>
     531
     532<h2>example reply</h2>
     533<blockquote>
    325534...todo...
    326535</blockquote>
Note: See TracChangeset for help on using the changeset viewer.