POST api/residents/{residentId}/notes

Create Audit Note

Request Information

URI Parameters

NameDescriptionTypeAdditional information
residentId

integer

Required

Body Parameters

string

Request Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'String'.

Response Information

Resource Description

<see cref="T:CamAcctApi.ViewModels.Notes.NoteCreatedViewModel" />

NoteCreatedViewModel
NameDescriptionTypeAdditional information
CreatedBy

CreatedBy

integer

None.

Id

Id

integer

None.

Note

Note

string

None.

IsSystemGenerated

IsSystemGenerated

boolean

None.

CreatedOn

CreatedOn

date

None.

Response Formats

application/json, text/json

Sample:
{
  "createdBy": 1,
  "id": 2,
  "note": "sample string 3",
  "isSystemGenerated": true,
  "createdOn": "2024-10-14T08:21:02.0244678-04:00"
}

application/xml, text/xml

Sample:
<NoteCreatedViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Notes">
  <CreatedOn>2024-10-14T08:21:02.0244678-04:00</CreatedOn>
  <Id>2</Id>
  <IsSystemGenerated>true</IsSystemGenerated>
  <Note>sample string 3</Note>
  <CreatedBy>1</CreatedBy>
</NoteCreatedViewModel>