Notes

Get Note

• Endpoint:

GET /landlords/{landlord_id}/notes/{id}
GET /leads/{lead_id}/notes/{id}

• Allowed for:

users that has right landlord.read users that has right lead.read

• JSON response:

Name	Type	Read-only	Comment
id	integer	yes	Automatically assigned when the landlord is created
lead/landlord	Lead/Landlord	no	Lead or Landlord owning the note
body	string	no	Landlord first name
created_at	date	yes	Note creation date (W3C format)
created_by	User	yes	Creator of the note
updated_at	date	yes	Note updated date (W3C format)
updated_by	User)	yes	Last user who has updated the notes

• JSON response example

{
  ...
  "notes": [{
    "id":                   35436,
    "landlord": {
        "id": 2,
    }
    "body":                 "This is a note",
    "created_at":           "2009-07-20T22:55:29Z",
    "created_by": {
        "id": 2,
    },
    "updated_at":           "2011-05-05T10:38:52Z",
    "created_by": {
        "id": 1,
    }
  }]
}

Get notes

• Endpoint:

GET /landlords/{landlord_id}/notes
GET /leads/{lead_id}/notes
GET /properties/{property_id}/notes
GET /transactions/{transaction_id}/notes

• Allowed for:
• users that has right property.read
• users that has right landlord.read
• users that has right lead.read

• users that has right transaction.read

• JSON response:

This endpoint will return a list of note.

• JSON response example:

{
    "count": 6,
    "page": 1,
    "per_page": 1,
    "notes": [
        {
            "id": 1,
            "property": {
                "id": 1
            },
            "body": "note 1",
            "created_by": {
                "id": 1
            },
            "updated_by": null,
            "created_at": "2019-02-21T07:26:12+04:00",
            "updated_at": "2019-02-21T07:26:12+04:00"
        }
    ]
}

• Sorting :

Name	Comment
created	sorting by note creation date
updated	sorting by note last update date

Create Note

• Endpoint:

POST /landlords/{landlord_id}/notes
POST /leads/{lead_id}/notes

• Allowed for:

users that has right landlord.update

users that has right lead.update

• JSON request data

Name	Type	Mandatory	Comment
body	string	no	content of the notes

• JSON request example:

{
  "note": {
      "content": "this is a created note",
      ...
  },
}

• JSON response:

This endpoint will return a Note.

Update Note

• Endpoint:

PUT /landlords/{landlord_id}/notes/{id}
PUT /leads/{lead_id}/notes/{id}

• Allowed for:

users that has right landlord.update users that has right lead.update

• JSON request data

| Name | Type | Mandatory | Comment | |---|---|---|---|---| | body | string | no | content of the notes |

• JSON request example:

{
  "note": {
      "content": "this is a created note",
      ...
  },
}

• JSON response:

Name	Type	Read-only	Comment
id	integer	yes	Automatically assigned when the landlord is created
lead/landlord	[L]	no	Lead or Landlord owning the note
body	string	no	Landlord first name
created_at	date	yes	Note creation date (W3C format)
created_by	User	yes	Creator of the note
updated_at	date	yes	Note updated date (W3C format)
updated_by	User	yes	Last user who has updated the notes creation date

• JSON response example

{
  ...
  "notes": [{
    "id":                   35436,
    "landlord": {
        "id": 2,
    }
    "body":                 "This is a note",
    "created_at":           "2009-07-20T22:55:29Z",
    "created_by": {
        "id": 2,
    },
    "updated_at":           "2011-05-05T10:38:52Z",
    "created_by": {
        "id": 1,
    }
  }]
}

Delete Note

• Endpoint:

DELETE /landlords/{landlord_id}/notes/{id}
DELETE /leads/{lead_id}/notes/{id}

• Allowed for:

users that has right landlord.update users that has right lead.update

• JSON response:

This endpoint will return a 204 http code if success.