POST api/address/solicitation/standardize
Request Information
URI Parameters
None.
Body Parameters
StandardizeAddressInputObject| Name | Description | Type | Additional information |
|---|---|---|---|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| ZipCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Address1": "sample string 1",
"Address2": "sample string 2",
"ZipCode": "sample string 3"
}
application/xml, text/xml
Sample:
<StandardizeAddressInputObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Solicitation_Tools_Solution.Models"> <Address1>sample string 1</Address1> <Address2>sample string 2</Address2> <ZipCode>sample string 3</ZipCode> </StandardizeAddressInputObject>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AddressObject| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressId | integer |
None. |
|
| AreaId | byte |
None. |
|
| StreetNumber | string |
None. |
|
| StreetPreDir | string |
None. |
|
| StreetName | string |
None. |
|
| StreetSuffix | string |
None. |
|
| StreetPostDir | string |
None. |
|
| SuiteType | string |
None. |
|
| SuiteNumber | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| ZipCode | string |
None. |
|
| ZipPlus4 | string |
None. |
|
| CR | string |
None. |
|
| AddressKey | string |
None. |
|
| GeoResults | string |
None. |
|
| GeoLat | string |
None. |
|
| GeoLon | string |
None. |
|
| AddressIsStandardized | boolean |
None. |
|
| StreetNumberUnknown | boolean |
None. |
|
| StreetNameUnknown | boolean |
None. |
|
| SuiteUnknown | boolean |
None. |
|
| CSZUnknown | boolean |
None. |
|
| InsufficientData | boolean |
None. |
|
| Highrise | boolean |
None. |
|
| DirtyAddress | string |
None. |
|
| PlusCode | string |
None. |
|
| AddressHTMLString | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"AddressId": 1,
"AreaId": 64,
"StreetNumber": "sample string 3",
"StreetPreDir": "sample string 4",
"StreetName": "sample string 5",
"StreetSuffix": "sample string 6",
"StreetPostDir": "sample string 7",
"SuiteType": "sample string 8",
"SuiteNumber": "sample string 9",
"City": "sample string 10",
"State": "sample string 11",
"ZipCode": "sample string 12",
"ZipPlus4": "sample string 13",
"CR": "sample string 14",
"AddressKey": "samplestring3samplestring4samplestring5samplestring6samplestring7#samplestring9#samplestring10samplestring11samplestring12",
"GeoResults": "sample string 15",
"GeoLat": "sample string 16",
"GeoLon": "sample string 17",
"AddressIsStandardized": true,
"StreetNumberUnknown": true,
"StreetNameUnknown": true,
"SuiteUnknown": true,
"CSZUnknown": true,
"InsufficientData": true,
"Highrise": true,
"DirtyAddress": "sample string 25",
"PlusCode": "sample string 26",
"AddressHTMLString": "sample string 25 in sample string 12<br />sample string 10, sample string 11 sample string 12"
}
application/xml, text/xml
Sample:
<AddressObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Solicitation_Tools_Solution.Models"> <AddressId>1</AddressId> <AddressIsStandardized>true</AddressIsStandardized> <AreaId>64</AreaId> <CR>sample string 14</CR> <CSZUnknown>true</CSZUnknown> <City>sample string 10</City> <DirtyAddress>sample string 25</DirtyAddress> <GeoLat>sample string 16</GeoLat> <GeoLon>sample string 17</GeoLon> <GeoResults>sample string 15</GeoResults> <Highrise>true</Highrise> <InsufficientData>true</InsufficientData> <PlusCode>sample string 26</PlusCode> <State>sample string 11</State> <StreetName>sample string 5</StreetName> <StreetNameUnknown>true</StreetNameUnknown> <StreetNumber>sample string 3</StreetNumber> <StreetNumberUnknown>true</StreetNumberUnknown> <StreetPostDir>sample string 7</StreetPostDir> <StreetPreDir>sample string 4</StreetPreDir> <StreetSuffix>sample string 6</StreetSuffix> <SuiteNumber>sample string 9</SuiteNumber> <SuiteType>sample string 8</SuiteType> <SuiteUnknown>true</SuiteUnknown> <ZipCode>sample string 12</ZipCode> <ZipPlus4>sample string 13</ZipPlus4> </AddressObject>