API version 1 Notes

1. List User Notes (api1/notes/user)

This method will answer with a collection of iinsight's user notes (note oriented data) that belong to a case. The collection will be in JSON format.
The results can be paginated, giving a limit per page not greater than 100 and it be filter by contact status, search criteria or sorted by asc or desc. An empty collection and a status code 200 response, means that there is no records in the specified page and filters.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/user	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/user	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
case_id	Case ID. (i.e.: 1)	Yes
fields	Contacs fields seperated by comma and no blank spaces. (i.e.: field_name1,field_name2,...)	Yes
sort_col	Sort by column field name. (i.e.: field_name)	No
sort_type	Sort column type. Options: asc, desc	No
search_criteria	Search field name. (i.e.: {"field_name1":"value1","field_name2":"value1,value2"})	No
page	The page number of the paginated results. (i.e.: 1)	No
limit	The limit amount of items. (i.e.: 1)	No
type	The type of note, it can be only priviled, exclude priviled or all. Default is all. (options: all,only,exclude)	No
start_date	Start Date of the search range. (i.e.: 01-01-2000)	No
end_date	End Date of the search range. (i.e.: 01-01-2000)	No

Response

[
        {
            "id": "1"
            "description": "xxx",
            "title": "xxx",
            "status": "unlocked/unlocked and privileged",
            "date_created": "dd-mm-yyyy",
            "date_modified": "dd-mm-yyyy",
            "signature": "data:image/png;base64",
            "role": "xxxx",
            "created_by": "xxx",
            "modified_by": "xxx"
        },
        {
            "id": "1"
            "description": "xxx",
            "title": "xxx",
            "status": "unlocked/unlocked and privileged",
            "date_created": "dd-mm-yyyy",
            "date_modified": "dd-mm-yyyy",
            "signature": "data:image/png;base64",
            "role": "xxxx",
            "created_by": "xxx",
            "modified_by": "xxx"
        }
]

2. User Note Details (api1/notes/user/details)

This method will answer with a collection of iinsight's user note details (note oriented data) that belong to a case. The collection will be in JSON format.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/user/details	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/user/details	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
id	User Note ID. (i.e.: 1)	Yes

Response


        {
            "id": "1"
            "description": "xxx",
            "title": "xxx",
            "is_privileged": "Yes/No",
            "status": "unlocked/unlocked and privileged",
            "date_created": "dd-mm-yyyy",
            "time_created": "hh:mm am/pm",
            "date_modified": "dd-mm-yyyy",
            "time_modified": "hh:mm am/pm",
            "signature": "data:image/png;base64",
            "role": "xxxx",
            "role_id": "1",
            "employee": "xx",
            "employee_id": "1",
            "created_by": "xxx",
            "modified_by": "xxx",
            "template_title": "xxx"
        }

3. New User Note (api1/notes/user/new)

This method will allow to create a new User Note.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/user/new	POST
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/user/new	POST

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
case_id	Case ID. (i.e.: 1)	Yes
employee_id	Employee ID. (i.e.: 1)	Yes
role_id	Employee's role ID. (i.e.: 1)	No
title	Note's title. (i.e.: Note 1)	Yes
date_created	Date created. (i.e.: dd-mm-yyyy)	No
time_created	Time created. (i.e.: hh:mm am/pm)	No
is_privileged	Privileged Note. (options: Yes/No)	No
description	Note's description. (max lenght 4 million chars)	No
signature	Employee signature. (data:image/png;base64)	No
template	Template's title. (i.e.: Name of the template)	No
billing_id	Billing ID (i.e.: 1)	No

Response


        {
          "response": "Note Created",
          "note_id": 115788
        }

4. Update User Note (api1/notes/user/update)

This method will allow to create a update User Note.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/user/update	PUT
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/user/update	PUT

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params (As it's PUT method this need to go on the x-www-form-urlencoded)

Parameter	Value	Mandatory
note_id	Note ID. (i.e.: 1)	Yes
employee_id	Employee ID. (i.e.: 1)	Yes
role_id	Employee's role ID. (i.e.: 1)	No
title	Note's title. (i.e.: Note 1)	Yes
date_created	Date created. (i.e.: dd-mm-yyyy)	No
time_created	Time created. (i.e.: hh:mm am/pm)	No
description	Note's description. (max lenght 4 million chars)	No
signature	Employee signature. (data:image/png;base64)	No
template	Template's title. (i.e.: Name of the template)	No
is_privileged	Privileged Note. (options: Yes/No)	No

Response


        {
          "response": "Note Updated",
          "note_id": 115788
        }

5. List clinical notes templates (api1/notes/templates)

This method will answer with a collection of clinical's notes templates. The collection will be in JSON format.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/templates	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/templates	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
is_external_form_template	Is external form templates. (Options: Yes/No)	Yes
search	Search by template's title. (i.e.: xxx)	No
page	The page number of the paginated results. (i.e.: 1)	No
limit	The limit amount of items. (i.e.: 1)	No

Response


    [
      {
          "id": 9,
          "name": "xxx"
      },
      {
          "id": 10,
          "name": "xxx"
      }
    ]

6. Get clinical notes template (api1/notes/template)

This method will answer with a clinical's notes template.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/template	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/template	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
case_id	Case ID. (i.e.: 1)	Yes
template_id	Template ID. (i.e.: 1)	Yes

Response


      {
        "template": "template in HTML format"
      }

7. List Document Notes (api1/notes/document)

This method will answer with a collection of iinsight's document notes that belong to a case. The collection will be in JSON format.
The results can be paginated, giving a limit per page not greater than 100 and it be filter by contact status, search criteria or sorted by asc or desc. An empty collection and a status code 200 response, means that there is no records in the specified page and filters.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/document	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/document	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
document_id	Document ID. (i.e.: 1)	Yes
fields	Contacs fields seperated by comma and no blank spaces. (i.e.: field_name1,field_name2,...)	Yes
sort_col	Sort by column field name. (i.e.: field_name)	No
sort_type	Sort column type. Options: asc, desc	No
search_criteria	Search field name. (i.e.: {"field_name1":"value1","field_name2":"value1,value2"})	No
page	The page number of the paginated results. (i.e.: 1)	No
limit	The limit amount of items. (i.e.: 1)	No

Response

[
        {
          "id": "1",
          "description": "xxx",
          "user": "xxx",
          "date": "dd-mm-yyyy"
        }
        {
          "id": "2",
          "description": "xxx",
          "user": "xxx",
          "date": "dd-mm-yyyy"
        }
]

8. New Document Note (api1/notes/document)

This method will allow you to create a document note.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/document	POST
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/document	POST

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
id	Document ID. (i.e.: 1)	Yes
description	Document note description.	Yes

Response

{
    "response": "Document note created successfuly",
    "id": 11
}

9. List Admin Notes (api1/notes/admin)

This method will answer with a collection of iinsight's admin notes (note oriented data) that belong to a case. The collection will be in JSON format.
The results can be paginated, giving a limit per page not greater than 100 and it be filter by contact status, search criteria or sorted by asc or desc. An empty collection and a status code 200 response, means that there is no records in the specified page and filters.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/admin	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/admin	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
case_id	Case ID. (i.e.: 1)	Yes
fields	Contacs fields seperated by comma and no blank spaces. (i.e.: field_name1,field_name2,...)	Yes
sort_col	Sort by column field name. (i.e.: field_name)	No
sort_type	Sort column type. Options: asc, desc	No
search_criteria	Search field name. (i.e.: {"field_name1":"value1","field_name2":"value1,value2"})	No
page	The page number of the paginated results. (i.e.: 1)	No
limit	The limit amount of items. (i.e.: 1)	No
type	The type of note, it can be only priviled, exclude priviled or all. Default is all. (options: all,only,exclude)	No
start_date	Start Date of the search range. (i.e.: 01-01-2000)	No
end_date	End Date of the search range. (i.e.: 01-01-2000)	No

Response

[
        {
            "id": "1"
            "description": "xxx",
            "title": "xxx",
            "status": "unlocked/unlocked and privileged",
            "date_created": "dd-mm-yyyy",
            "date_modified": "dd-mm-yyyy",
            "role": "xxxx",
            "created_by": "xxx",
            "modified_by": "xxx"
        },
        {
            "id": "1"
            "description": "xxx",
            "title": "xxx",
            "status": "unlocked/unlocked and privileged",
            "date_created": "dd-mm-yyyy",
            "date_modified": "dd-mm-yyyy",
            "role": "xxxx",
            "created_by": "xxx",
            "modified_by": "xxx"
        }
]

10. Admin Note Details (api1/notes/admin/details)

This method will answer with a collection of iinsight's Admin note details (note oriented data) that belong to a case. The collection will be in JSON format.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/admin/details	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/admin/details	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
id	Admin Note ID. (i.e.: 1)	Yes

Response


    {
      "id": "1",
      "is_privileged": "Yes",
      "date_created": "10-10-2010",
      "date_modified": "22-04-2024",
      "time_created": "06:23 pm",
      "time_modified": "06:50 am",
      "title": "Test title",
      "description": "Test description"
    }

11. New Admin Note (api1/notes/admin/new)

This method will allow to create a new Admin Note.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/admin/new	POST
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/admin/new	POST

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
case_id	Case ID. (i.e.: 1)	Yes
title	Note's title. (i.e.: Note 1)	Yes
date_created	Date created. (i.e.: dd-mm-yyyy)	No
time_created	Time created. (i.e.: hh:mm am/pm)	No
is_privileged	Privileged Note. (options: Yes/No)	No
description	Note's description. (max lenght 4 million chars)	No

Response


        {
          "response": "Note Created",
          "note_id": 115788
        }

12. Update Admin Note (api1/notes/admin/update)

This method will allow to update Admin Note.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/admin/update	PUT
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/admin/update	PUT

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params (As it's PUT method this need to go on the x-www-form-urlencoded)

Parameter	Value	Mandatory
note_id	Note ID. (i.e.: 1)	Yes
title	Note's title. (i.e.: Note 1)	Yes
date_created	Date created. (i.e.: dd-mm-yyyy)	No
time_created	Time created. (i.e.: hh:mm am/pm)	No
description	Note's description. (max lenght 4 million chars)	No
is_privileged	Privileged Note. (options: Yes/No)	No

Response


        {
          "response": "Note Updated",
          "note_id": 115788
        }

13. List Case Log Notes (api1/notes/log)

This method will answer with a collection of iinsight's case log notes (note oriented data) that belong to a case. The collection will be in JSON format.
The results can be paginated, giving a limit per page not greater than 100 and it be filter by contact status, search criteria or sorted by asc or desc. An empty collection and a status code 200 response, means that there is no records in the specified page and filters.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/log	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/log	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
case_id	Case ID. (i.e.: 1)	Yes
fields	Contacs fields seperated by comma and no blank spaces. (i.e.: field_name1,field_name2,...)	Yes
sort_col	Sort by column field name. (i.e.: field_name)	No
sort_type	Sort column type. Options: asc, desc	No
search_criteria	Search field name. (i.e.: {"field_name1":"value1","field_name2":"value1,value2"})	No
page	The page number of the paginated results. (i.e.: 1)	No
limit	The limit amount of items. (i.e.: 1)	No
type	The type of note, it can be only priviled, exclude priviled or all. Default is all. (options: all,only,exclude)	No
start_date	Start Date of the search range. (i.e.: 01-01-2000)	No
end_date	End Date of the search range. (i.e.: 01-01-2000)	No

Response

[
          {
            "id": "116181",
            "title": "Notes 115626: 'test2123' has been edited",
            "status": "locked",
            "description": "details",
            "date": "22-04-2024",
            "role": "Case Manager",
            "user": "John doe",
            "billing_id": ""
        },
        {
            "id": "116182",
            "title": "Notes 115621: 'test2124' has been edited",
            "status": "locked",
            "description": "details",
            "date": "22-04-2024",
            "role": "Case Manager",
            "user": "John doe",
            "billing_id": ""
        },
]

14. Case Log Note Details (api1/notes/log/details)

This method will answer with a collection of iinsight's Case Log note details (note oriented data) that belong to a case. The collection will be in JSON format.

URL

Server	URL	HTTP type
UAT	https://api-aus-uat.iinsightonline.com/api1/notes/log/details	GET
PRODUCTION	https://api-aus.iinsightonline.com/api1/notes/log/details	GET

Authorization

Parameter	Value	Mandatory
Type	Bearer Token	Yes
Token	The token is generated using the /auth/login method	Yes

Query Params

Parameter	Value	Mandatory
id	Admin Note ID. (i.e.: 1)	Yes

Response


    {
        "id": "116180",
        "is_privileged": "No",
        "title": "Notes 115626: 'test2123' has been edited",
        "description": "Description"
    }