Notes
Note information

Discussion

A note is freeform text about a tenant, unit, or ledger.
A tenant, unit, or ledger id must be provided. If a ledger id is provided, the unit and tenant id will be automatically selected.

>>>

POST /v1/:facility_id/tenants/:tenant_id/notes
Create a new note on a tenant or unit.

POST /v1/:facility_id/notes
Create a new note on a tenant or unit.

Examples

POST /v1/86374676-8c2b-4f5c-ac1c-60728fb5be75/notes
{
  "note": {
    "note_text": "Don't trust his lies.",
    "tenant_id": "70313148-c897-432b-a059-17f556705964"
  }
}
200
{
  "note_event": {
    "id": "528c1241-bb8d-4b08-a504-ec7d72988614",
    "notes": [
      {
        "id": "0bbd8832-2037-4d0b-b760-673c3d03a596",
        "note": "Don't trust his lies.",
        "created_at": "2022-09-12T22:37:22.103-10:00"
      }
    ],
    "created_by": {
      "id": "9dc12c0c-7035-446f-b93f-f41b523cfc65",
      "name": "Test App",
      "type": "ClientApplication"
    },
    "unit_id": null,
    "tenant_id": "70313148-c897-432b-a059-17f556705964"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "note": {
        "note_text": "Don't trust his lies.",
        "tenant_id": "70313148-c897-432b-a059-17f556705964"
      },
      "facility_id": "86374676-8c2b-4f5c-ac1c-60728fb5be75"
    }
  }
}

Params

Param name Description
user_id
required
Value: Must be a String
note
required
Value: Must be a Hash
note[note_text]
required
Value: Must be a String
note[tenant_id]
optional
Value: Must be a String
note[ledger_id]
optional
Value: Must be a String
note[unit_id]
optional
Value: Must be a String