getNotes.md

getNotes

Returns an array of all structured student medical notes details data in JSON format.

• Version History:

  TASS v52.3 - Method Added

  TASS v54.0 - Add a new conditional field currentstatus, change the required field studcode to a conditional field. Add new validations for studcode and currentstatus.

• Version:

  3

• Permission:

  Student Records > Students > Students > View

• Method:

  GET | POST

• Params:

  Required:

  None

  Optional:

  None

  Conditional:

  currentstatus [string] - Required if studcode is not supplied. Must be 'current' or 'future' or 'past' or 'noncurrent'.

  studcode [string] - Required if currentstatus is not supplied. Contains Only One Student Code if supplied.

• Success Response:

  when currentstatus is supplied

  {
      "data":[
          {
              "studcode":"0009130",
              "studnotes":[
                  {
                      "note_date":"2019-09-26 11:06:52.0",
                      "ncat_desc":"General",
                      "note_text":"Testing with atttachment",
                      "entry_code":"fang",
                      "entry_date":"2019-09-26 00:00:00.0",
                      "attach_url":"inline-file.cfm?do=ui.web.note.attachment&note_cat=GEN&note_date=2019-09-26 11:06:52.0&note_num=&entity_type=S&entity_code=0009130&notetype=standard",
                      "attach_id":"2F8F9A77-E2B9-28D5-611EDE1D0A66D623",
                      "note_cat":"GEN"
                  },
                  {
                      "note_date":"2018-09-04 11:05:50.0",
                      "ncat_desc":"General",
                      "note_text":"Test note only",
                      "entry_code":"tsloman",
                      "entry_date":"2018-09-04 00:00:00.0",
                      "attach_url":"",
                      "attach_id":"",
                      "note_cat":"GEN"
                  }
              ]
          },
          {
              "studcode":"0009134",
              "studnotes":[
                  {
                      "note_date":"2017-09-11 17:49:03.0",
                      "ncat_desc":"General",
                      "note_text":"Lauren will be doing extra Science this term",
                      "entry_code":"AJ",
                      "entry_date":"2017-09-11 00:00:00.0",
                      "attach_url":"",
                      "attach_id":"",
                      "note_cat":"GEN"
                  }
              ]
          }
      ],
      "__tassversion":"01.000.043.0",
      "token":{
          "timestamp":"{ts '2020-11-12 09:58:10'}",
          "currentstatus":"current"
      }
  }

  when only studcode is supplied

  {
      "data":[
          {
              "note_date":"2019-09-26 11:06:52.0",
              "ncat_desc":"General",
              "note_text":"Testing with atttachment",
              "entry_code":"fang",
              "entry_date":"2019-09-26 00:00:00.0",
              "attach_url":"inline-file.cfm?do=ui.web.note.attachment&note_cat=GEN&note_date=2019-09-26 11:06:52.0&note_num=&entity_type=S&entity_code=0009130&notetype=standard",
              "attach_id":"2F8F9A77-E2B9-28D5-611EDE1D0A66D623",
              "note_cat":"GEN"
          },
          {
              "note_date":"2018-09-04 11:05:50.0",
              "ncat_desc":"General",
              "note_text":"Test note only",
              "entry_code":"tsloman",
              "entry_date":"2018-09-04 00:00:00.0",
              "attach_url":"",
              "attach_id":"",
              "note_cat":"GEN"
          }
      ],
      "__tassversion":"01.000.043.0",
      "token":{
          "timestamp":"{ts '2020-11-12 09:57:53'}",
          "studcode":"0009130"
      }
  }

• Error Response:

  studcode and currentstatus are both not supplied

    "error": "studcode or currentstatus is required."

  studcode contains more than one student code

    "error": "Only one studcode can be processed at a time."

  studcode does not exist in currentstatus student list

    "error": "[studcode] is not a valid [currentstatus] student."

  currentstatus does not match 'current' or 'future' or 'past' or 'noncurrent'

    "error": "[currentstatus] must be 'current' or 'future' or 'past' or 'noncurrent'."

• Sample Parameters:

  when currentstatus is supplied

    {
      "currentstatus":"current"
    }

  when only studcode is supplied

    {
      "studcode":"0009130"
    }

• Sample GET: (With URL Encoded token)

    http://api.tasscloud.com.au/tassweb/api/?method=getNotes&appcode=API12&company=10&v=3&token=l1D8owEn111IHcXLRwXTB0oU2GX6rj%2BISqa9zXA8We3J3mwgjW5pdUvFK3%2FIZ4mJ4bMyfKTmEoup%2B3tTE9GeLQ%3D%3D

• Sample POST:

    <form id="postForm" name="postForm" method="POST" action="http://api.tasscloud.com.au/tassweb/api/">
       <input type="hidden" name="method" value="getNotes">
       <input type="hidden" name="appcode" value="API12">
       <input type="hidden" name="company" value="10">
       <input type="hidden" name="v" value="3">
       <textarea name="token">l1D8owEn111IHcXLRwXTB0oU2GX6rj+ISqa9zXA8We3J3mwgjW5pdUvFK3/IZ4mJ4bMyfKTmEoup+3tTE9GeLQ==</textarea>
    </form>