PUT api/ResidentMessage?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}

Retrieves resident push notes

Request Information

URI Parameters

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

Body Parameters

ResidentMessage structure

ResidentMessage

Name	Type	Additional information
ResidentNoteKey	integer	None.
ResidentKey	integer	None.
rn_NoteDate	date	None.
rn_Type	string	None.
rn_Note	string	None.
rn_NoteReadStatus	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ResidentNoteKey": 1,
  "ResidentKey": 2,
  "rn_NoteDate": "2025-10-27T12:13:59.4482074-07:00",
  "rn_Type": "sample string 4",
  "rn_Note": "sample string 5",
  "rn_NoteReadStatus": 6
}

application/xml, text/xml

Sample:

<ResidentMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesResident">
  <ResidentKey>2</ResidentKey>
  <ResidentNoteKey>1</ResidentNoteKey>
  <rn_Note>sample string 5</rn_Note>
  <rn_NoteDate>2025-10-27T12:13:59.4482074-07:00</rn_NoteDate>
  <rn_NoteReadStatus>6</rn_NoteReadStatus>
  <rn_Type>sample string 4</rn_Type>
</ResidentMessage>

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.