GET api/residents/{residentId}/residentNotes

Get resident notes

Request Information

URI Parameters

NameDescriptionTypeAdditional information
residentId

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of ResidentNoteViewModel

Collection of ResidentNoteViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

Comment

string

None.

NoteDate

date

None.

Description

string

None.

NoteType

string

None.

ResidentNoteType

ResidentNoteTypeViewModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "comment": "sample string 2",
    "noteDate": "2024-10-14T08:21:00.862698-04:00",
    "description": "sample string 4",
    "noteType": "sample string 5",
    "residentNoteType": {
      "hasResidentNotes": true,
      "code": "sample string 2",
      "description": "sample string 3"
    }
  },
  {
    "id": 1,
    "comment": "sample string 2",
    "noteDate": "2024-10-14T08:21:00.862698-04:00",
    "description": "sample string 4",
    "noteType": "sample string 5",
    "residentNoteType": {
      "hasResidentNotes": true,
      "code": "sample string 2",
      "description": "sample string 3"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfResidentNoteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <ResidentNoteViewModel>
    <Comment>sample string 2</Comment>
    <Description>sample string 4</Description>
    <Id>1</Id>
    <NoteDate>2024-10-14T08:21:00.862698-04:00</NoteDate>
    <NoteType>sample string 5</NoteType>
    <ResidentNoteType>
      <Code>sample string 2</Code>
      <Description>sample string 3</Description>
      <HasResidentNotes>true</HasResidentNotes>
    </ResidentNoteType>
  </ResidentNoteViewModel>
  <ResidentNoteViewModel>
    <Comment>sample string 2</Comment>
    <Description>sample string 4</Description>
    <Id>1</Id>
    <NoteDate>2024-10-14T08:21:00.862698-04:00</NoteDate>
    <NoteType>sample string 5</NoteType>
    <ResidentNoteType>
      <Code>sample string 2</Code>
      <Description>sample string 3</Description>
      <HasResidentNotes>true</HasResidentNotes>
    </ResidentNoteType>
  </ResidentNoteViewModel>
</ArrayOfResidentNoteViewModel>