Table of Contents
Person Notes are pieces of information left by an Intake User during the intake process for reference and communication purposes. Person Notes are both associated with a Person and a Referral Process Document.
There are two types of Person Notes: Internal Notes and Contact Logs. Internal Notes are comments left on a Referral Process Document by Intake Users for later reference. Contact Logs are records of communication with entities outside the organization in relation to the Person or the Referral Process Document.
Sample Request #
| Headers | Authorization = Bearer [token] |
| Parameters | None |
| Body | None |
Get all Person Notes for a Person #
GET https://connect.supportableapp.com/api/persons/{personId}/person-notes
Get a specific Person Note #
GET https://connect.supportableapp.com/api/persons/{personId}/person-notes/{personNoteId}
Get all Contact Logs for a Specific Referral Process Document #
GET https://connect.supportableapp.com/api/persons/
{personId}/person-notes?processDocumentId={processDocumentId}&type=contactLog
Sample Response JSON #
Status: 200
[
{
"id": "639947b0375b94cfdaedad39",
"personId": "63994727375b94cfdaedad34",
"processDocumentId": "63994727375b94cfdaedad35",
"subEntityId": "6398b8a6904c0725a6e560f2",
"offeringId": "6311a1dac42741794219e7bd",
"addedByUserId": "631b7fccb85f7b84cd478b29",
"typeOfLog": "Contact Log",
"createdAtUtc": "2022-12-14T03:47:00.000Z",
"communicationMeans": {
"id": "625cfb34adee3dc64296dcc6",
"status": true,
"name": "Phone Out"
},
"communicatedWith": "Liam Liamson",
"notes": "I called Liam and talked to them on the phone. Gathered all information
required during this phone call and we have what we need to assess.",
"status": true
},
{
"id": "63a35bc09f76a83b448d548d",
"personId": "63994727375b94cfdaedad34",
"processDocumentId": "639962cc375b94cfdaedad59",
"subEntityId": "6398b8a6904c0725a6e560f2",
"offeringId": "6398c08d904c0725a6e560fa",
"addedByUserId": "631b7fccb85f7b84cd478b29",
"typeOfLog": "Internal Note",
"createdAtUtc": "2022-12-21T19:16:00.000Z",
"communicationMeans": null,
"communicatedWith": null,
"notes": "This is a test note.",
"status": true
},
. . .
]
Notes on Values #
| Attribute | Data Type | Description |
|---|---|---|
| id | string | The unique identifier for the Person Note. |
| personId | string | The unique identifier for the Person with whom the Person Note is associated. |
| processDocumentId | string | The unique identifier for the Referral Process Document with which the Person Note is associated. |
| subEntityId | string | The unique identifier of the Sub-Entity with which the Person Note is associated. |
| offeringId | string | TThe unique identifier of the Offering with which the Person Note is associated. |
| addedByUserId | string | The unique identifier of the Intake User who created the Person Note. |
| typeOfLog | string | The type of Person Note. (Note: Will be either “Contact Log” or “Internal Note”) |
| createdAtUtc | datetime | The ISO datetime value, in UTC, at which the Person Note was created, if of Internal Note type, or the ISO datetime value, in UTC, at which the communication was reported to take place, if of Contact Log type. |
| communicationMeans | object | The means of communication used, if of Contact Log type. |
| communicationMeans.id | string | The unique identifier of the communication means. |
| communicationMeans.name | string | The name of the communication means, as it appears in the application. |
| communicationMeans.status | boolean | Whether the communication means is active in Supportable. |
| communicatedWith | string | The point of contact with which the Intake User communicated, if of Contact Log type. |
| typeOfLog | notes | TThe content of the Person Note. |
| typeOfLog | status | Whether the Person Note is active in Supportable. |
