Skip to content
Neuroassure Logo

Spec

Home/Spec
Specsquibm2018-05-01T14:58:18-06:00

URL Parameters

If it were me I would use the fol­low­ing URL con­ven­tion to admin­is­ter the tests system:

Verbs:

  • action={ cre­ate | test | report | query }

Verb Para­me­ters & Returns:

  • cre­ate
    • SubjectID={string for user}
    • Gender={m | f}
    • Hand={r | l}
    • BY={19xx — 20xx}
    • BM=(1–12}
    • BD=(1–31}
    • Return: Suc­cess or fail
  • test
    • Sub­jec­tID={ Subject }
    • PackageID={Test pack­age definition}
    • Return: Link to test
  •  report 
    • Sub­jec­tID
    • type={graph | single} 
      • if type=single
      • TestID={test ID}
    • Return: URL to Report
  • query
    • Sub­jec­tID
    • Return: Sub­ject Details, array of test IDs

Exam­ple URL Strings:

  • Cre­ate a Sub­ject: https://sync.cnsvs.com/api?action=create&SubjectID=ralph&Gender=m&Hand=r&BY=1972&BM=3&BD=28
  • Cre­ate a Test: https://sync.cnsvs.com/api?action=test&SubjectID=ralph
  • Retrieve a Graph Report: https://sync.cnsvs.com/api?action=report&SubjectID=ralph&type=graph
  • Retrieve a Test: https://sync.cnsvs.com/api?action=report&SubjectID=ralph&type=single&TestID={xyzzab}
  • Retrieve info for a Sub­ject: https://sync.cnsvs.com/api?action=query&SubjectID=ralph

Client Jobs:

  1. Retain Sub­ject ID rel­a­tive to id strings
  2. Set­up the tests
  3. Man­age tak­ing of tests.

Test Fram­ing:

  • Ide­al­ly we would admin­is­ter the test with­in an iframe to min­i­mize dis­ori­en­ta­tion of the client while tak­ing the test.  Same page
  • Ide­al­ly flow from test sign up to tak­ing the test with­out ever pass­ing an email.

Test Automation

As our process con­tin­ues we will call your test inter­face with the Sub­jec­tID.  A call should return the URL to a test admin­is­tra­tion page as with the remote link.

The sim­ple goal is to enable us to con­fig­ure the sub­ject once, and then auto­mate test admin­is­tra­tion thereafter.

We will send a reg­u­lar email to the par­ent invit­ing them to set­up their child for the test.

Archives

  • April 2018

Categories

  • Uncategorized

Meta

  • Log in
  • Entries feed
  • Comments feed
  • WordPress.org
Copyright 2012 - 2018 Whole Health Network, LLC | All Rights Reserved. Not intended to diagnose, cure, prevent or mitigate any disease.
Go to Top