PUT api/ResidentContactNotification?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}
Put ResidentContact record
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| VendorID | string |
Required |
|
| VendorPassword | string |
Required |
|
| APIGUID | string |
Required |
Body Parameters
ResidentContactNotification structure
ResidentContactNotification| Name | Description | Type | Additional information |
|---|---|---|---|
| ResidentContactKey | integer |
None. |
|
| rc_SendCalendarEvent | boolean |
None. |
|
| rc_SendClassified | boolean |
None. |
|
| rc_SendLatePayment | boolean |
None. |
|
| rc_SendPayment | boolean |
None. |
|
| rc_ViolationNotice | boolean |
None. |
|
| rc_SendSurvey | boolean |
None. |
|
| rc_SendNews | boolean |
None. |
|
| rc_SendArchitectural | boolean |
None. |
|
| rc_SendWorkOrder | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"ResidentContactKey": 1,
"rc_SendCalendarEvent": true,
"rc_SendClassified": true,
"rc_SendLatePayment": true,
"rc_SendPayment": true,
"rc_ViolationNotice": true,
"rc_SendSurvey": true,
"rc_SendNews": true,
"rc_SendArchitectural": true,
"rc_SendWorkOrder": true
}
application/xml, text/xml
Sample:
<ResidentContactNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesResident"> <ResidentContactKey>1</ResidentContactKey> <rc_SendArchitectural>true</rc_SendArchitectural> <rc_SendCalendarEvent>true</rc_SendCalendarEvent> <rc_SendClassified>true</rc_SendClassified> <rc_SendLatePayment>true</rc_SendLatePayment> <rc_SendNews>true</rc_SendNews> <rc_SendPayment>true</rc_SendPayment> <rc_SendSurvey>true</rc_SendSurvey> <rc_SendWorkOrder>true</rc_SendWorkOrder> <rc_ViolationNotice>true</rc_ViolationNotice> </ResidentContactNotification>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |