POST api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}

Request Information

URI Parameters

Name	Type	Additional information
VendorID	string	Required
VendorPassword	string	Required
APIGUID	string	Required

Body Parameters

ResidentNote

Name	Type	Additional information
ResidentNoteKey	integer	None.
rn_Created	date	None.
ResidentKey	integer	None.
rn_Type	string	None.
rn_OpenEmployeeKey	integer	None.
rn_CloseEmployeeKey	integer	None.
rn_NoteDate	date	None.
rn_Note	string	None.
rn_Completed	date	None.
rn_Contact	string	None.
rn_FileName	string	None.
rn_OnWeb	boolean	None.
rn_Category1	string	None.
rn_Category2	string	None.
rn_ResponsibleEmployeeKey	integer	None.
rn_Resolution	string	None.
ImageBase64	string	None.
rn_NoteReadStatus	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ResidentNoteKey": 1,
  "rn_Created": "2025-10-27T12:15:30.3922678-07:00",
  "ResidentKey": 3,
  "rn_Type": "sample string 4",
  "rn_OpenEmployeeKey": 5,
  "rn_CloseEmployeeKey": 6,
  "rn_NoteDate": "2025-10-27T12:15:30.3922678-07:00",
  "rn_Note": "sample string 8",
  "rn_Completed": "2025-10-27T12:15:30.3922678-07:00",
  "rn_Contact": "sample string 10",
  "rn_FileName": "sample string 11",
  "rn_OnWeb": true,
  "rn_Category1": "sample string 13",
  "rn_Category2": "sample string 14",
  "rn_ResponsibleEmployeeKey": 15,
  "rn_Resolution": "sample string 16",
  "ImageBase64": "sample string 17",
  "rn_NoteReadStatus": 18
}

application/xml, text/xml

Sample:

<ResidentNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesResident">
  <ImageBase64>sample string 17</ImageBase64>
  <ResidentKey>3</ResidentKey>
  <ResidentNoteKey>1</ResidentNoteKey>
  <rn_Category1>sample string 13</rn_Category1>
  <rn_Category2>sample string 14</rn_Category2>
  <rn_CloseEmployeeKey>6</rn_CloseEmployeeKey>
  <rn_Completed>2025-10-27T12:15:30.3922678-07:00</rn_Completed>
  <rn_Contact>sample string 10</rn_Contact>
  <rn_Created>2025-10-27T12:15:30.3922678-07:00</rn_Created>
  <rn_FileName>sample string 11</rn_FileName>
  <rn_Note>sample string 8</rn_Note>
  <rn_NoteDate>2025-10-27T12:15:30.3922678-07:00</rn_NoteDate>
  <rn_NoteReadStatus>18</rn_NoteReadStatus>
  <rn_OnWeb>true</rn_OnWeb>
  <rn_OpenEmployeeKey>5</rn_OpenEmployeeKey>
  <rn_Resolution>sample string 16</rn_Resolution>
  <rn_ResponsibleEmployeeKey>15</rn_ResponsibleEmployeeKey>
  <rn_Type>sample string 4</rn_Type>
</ResidentNote>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.