setStudentMedicalConfidentialNote.md

setStudentMedicalNote

Returns "success" and a count of updated and/or failed student medical notes record(s), or a structure of invalid validations messages belonging to student medical notes record(s).

• Version History:

  TASS v57.8.100 - Method Added

• Version:

  3

• Permission:

  Medical Records > Student Medical > Confidential Notes tab > Add

• Method:

  GET | POST

• Params:

  Required:

  stud_code [string] - Student Code

  note_date [date] - Confidential Note Date

  note_cat [string] - Confidential Note Category Code

  note_text [string] - Confidential Note Text

  Optional:

  note_attach_id [string] - Confidential Note Attachment.

  Conditional:

  attachment_file [string] - Base64 Encoded. Field is required where 'attachment_file_name' is supplied. (URLEncoded Format is RECOMMENDED)

  attachment_file_name [string] - Field is required where 'attachment_file' is supplied.

• Success Response:

  {
    "success":"You successfully saved Enrolled Student Confidential Medical Note.",
    "__tassversion":"01.054.4.000",
    "token":{
      "note_date":"16/06/2022",
      "stud_code":"0009130",
      "attachments":{
        "attachment_file_name":"test",
        "attachment_file":"ClRoaXMgaXMgYSB0ZXN0IGZpbGUuCkRvIG5vdCBpbmNsdWRlIGEgdGFibGUhISEKTmFtZQlRdWFudGl0eQlWYWx1ZQppUGFkCTEJNTAwCmlQaG9uZQkxCTEwMDAKVG90YWwJMgkxNTAw"
      },
      "timestamp":"{ts '2022-06-27 12:38:18'}",
      "note_text":"note text test",
      "note_cat":"GEN"
    }
  }

• Error Response:

  stud_code not supplied

  __invalid: {
    "__msg": "stud_code' is required."
  }

  note_date not supplied

  __invalid: {
    "__msg": "note_date' is required."
  }

  note_cat not supplied

  __invalid: {
    "__msg": "note_cat' is required."
  }

  note_text not supplied

  __invalid: {
    "__msg": "note_text' is required."
  }

  note_cat does not exist in practitioner type setup

  __invalid: {
    "[note_cat]": "Medical Note Category does not exist."
  }

  stud_code not a valid student code in table d3_enrolments

  __invalid: {
    "stud_code": "Enrolled student not in staging table."
  }

  stud_code not a valid student code in table studenrol

  __invalid: {
    "stud_code": "Enrolled student not in TASS."
  }

  stud_code is a valid student code in table studenrol where canc_flg = "Y"

  __invalid: {
    "stud_code": "Enrolled student has been cancelled."
  }

  stud_code is a valid student code in table studenrol where tran_sts = "T"

  __invalid: {
    "stud_code": "Enrolled student has been transferred to Current."
  }

  note_text over 4000 characters

  __invalid: {
    "note_text": "'note_text' exceeded 4000 characters."
  }

  note_attach_id [string] is empty, or only one of attachment_file and attachment_file_name is passed in

  __invalid: {
    "[field]": "attachment_file and attachment_file_name are required if [field] is passed in."
  }

  note_attach_id [string] attachment_file is passed in but attachment_file_name is not passed in

  __invalid: {
    "attachment_file_name": "attachment_file_name field is required where 'attachment_file' is supplied."
  }

  note_attach_id [string] attachment_file_name is passed in but attachment_file is not passed in

  __invalid: {
    "attachment_file": "attachment_file field is required where 'attachment_file_name' is supplied."
  }

  note_attach_id [string] attachment_file_name exceeds 255 characters

  __invalid: {
    "attachment_file_name": "attachment_file_name must be between 1 and 255 characters."
  }

• Sample Parameters:

  {
    "stud_code":"0009130",
    "note_date":"16/06/2022",
    "note_cat":"GEN",
    "note_text":"note text test",
    "attachments":{
        "attachment_file_name":"test",
        "attachment_file":"ClRoaXMgaXMgYSB0ZXN0IGZpbGUuCkRvIG5vdCBpbmNsdWRlIGEgdGFibGUhISEKTmFtZQlRdWFudGl0eQlWYWx1ZQppUGFkCTEJNTAwCmlQaG9uZQkxCTEwMDAKVG90YWwJMgkxNTAw"
    }
  }

• Sample GET: (With URL Encoded token)

    http://api.tasscloud.com.au/tassweb/api/?method=setStudentMedicalNote&appcode=API04&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="setStudentMedicalNote">
       <input type="hidden" name="appcode" value="API04">
       <input type="hidden" name="company" value="10">
       <input type="hidden" name="v" value="3">
       <textarea name="token">l1D8owEn111IHcXLRwXTB0oU2GX6rj+ISqa9zXA8We3J3mwgjW5pdUvFK3/IZ4mJ4bMyfKTmEoup+3tTE9GeLQ==</textarea>
    </form>