Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| addressHistoryId |
The addressHistory identifier. |
integer |
Required |
Body Parameters
The address history.
Nano.AddressHistory| Name | Description | Type | Additional information |
|---|---|---|---|
| endDate |
Gets or sets the end date. |
string |
None. |
| isCurrent |
Gets or sets a value indicating whether it is current. |
boolean |
None. |
| isMailing |
Gets or sets a value indicating whether it is mailing. |
boolean |
None. |
| rentOwnFree |
Gets or sets the rent own free. |
string |
None. |
| startDate |
Gets or sets the start date. |
string |
None. |
| id |
Gets or sets the address history identifier. |
integer |
None. |
| address |
Gets or sets the address identifier. |
integer |
None. |
| person |
Gets or sets the person identifier. |
integer |
None. |
Request Formats
application/json, text/json
{
"endDate": "sample String 1",
"isCurrent": true,
"isMailing": true,
"rentOwnFree": "sample String 4",
"startDate": "sample String 5",
"id": "6",
"address": "7",
"person": "8"
}
text/html
{"endDate":"sample String 1","isCurrent":true,"isMailing":true,"rentOwnFree":"sample String 4","startDate":"sample String 5","id":"6","address":"7","person":"8"}
application/xml, text/xml
<AddressHistory xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <EndDate>sample String 1</EndDate> <IsCurrent>true</IsCurrent> <IsMailing>true</IsMailing> <RentOwnFree>sample String 4</RentOwnFree> <StartDate>sample String 5</StartDate> <AddressHistoryId>6</AddressHistoryId> <AddressId>7</AddressId> <PersonId>8</PersonId> </AddressHistory>
application/x-www-form-urlencoded
Sample not available.
application/vnd.api+json
Sample not available.
Response Information
Resource Description
The updated address history.
Nano.AddressHistory| Name | Description | Type | Additional information |
|---|---|---|---|
| endDate |
Gets or sets the end date. |
string |
None. |
| isCurrent |
Gets or sets a value indicating whether it is current. |
boolean |
None. |
| isMailing |
Gets or sets a value indicating whether it is mailing. |
boolean |
None. |
| rentOwnFree |
Gets or sets the rent own free. |
string |
None. |
| startDate |
Gets or sets the start date. |
string |
None. |
| id |
Gets or sets the address history identifier. |
integer |
None. |
| address |
Gets or sets the address identifier. |
integer |
None. |
| person |
Gets or sets the person identifier. |
integer |
None. |
Response Formats
application/json, text/json
{
"endDate": "sample String 1",
"isCurrent": true,
"isMailing": true,
"rentOwnFree": "sample String 4",
"startDate": "sample String 5",
"id": "6",
"address": "7",
"person": "8"
}
text/html
{"endDate":"sample String 1","isCurrent":true,"isMailing":true,"rentOwnFree":"sample String 4","startDate":"sample String 5","id":"6","address":"7","person":"8"}
application/xml, text/xml
<AddressHistory xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <EndDate>sample String 1</EndDate> <IsCurrent>true</IsCurrent> <IsMailing>true</IsMailing> <RentOwnFree>sample String 4</RentOwnFree> <StartDate>sample String 5</StartDate> <AddressHistoryId>6</AddressHistoryId> <AddressId>7</AddressId> <PersonId>8</PersonId> </AddressHistory>
application/vnd.api+json
Sample not available.