This wiki is no longer being updated as of December 10, 2025.
|
Global Address Verification:Batch JSON: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
==JSON Batch Request== | ==JSON Batch Request== | ||
A maximum of up to 100 records per request can be sent. You must have < | A maximum of up to 100 records per request can be sent. You must have "'''<code>Accept: application/json</code>'''" in the http header. | ||
<pre> | <pre> | ||
{ | { | ||
| Line 52: | Line 52: | ||
"SubNationalArea":"string", | "SubNationalArea":"string", | ||
"Country":"string" | "Country":"string" | ||
}] | }] | ||
} | } | ||
</pre> | </pre> | ||
==JSON Batch Response== | ==JSON Batch Response== | ||
| Line 87: | Line 83: | ||
"AdministrativeArea":"string", | "AdministrativeArea":"string", | ||
"PostalCode":"string", | "PostalCode":"string", | ||
"PostalCodeType":"string", | |||
"AddressType":"string", | "AddressType":"string", | ||
"AddressKey":"string", | "AddressKey":"string", | ||
| Line 94: | Line 91: | ||
"CountryISO3166_1_Alpha3":"string", | "CountryISO3166_1_Alpha3":"string", | ||
"CountryISO3166_1_Numeric":"string", | "CountryISO3166_1_Numeric":"string", | ||
"CountrySubdivisionCode":"string", | |||
"Thoroughfare":"string", | "Thoroughfare":"string", | ||
"ThoroughfarePreDirection":"string", | "ThoroughfarePreDirection":"string", | ||
| Line 113: | Line 111: | ||
"PostBox":"string", | "PostBox":"string", | ||
"Latitude":"string", | "Latitude":"string", | ||
"Longitude":"string" | "Longitude":"string", | ||
"DeliveryIndicator":"string", | |||
"MelissaAddressKey":"string", | |||
"MelissaAddressKeyBase":"string", | |||
"PostOfficeLocation":"string", | |||
"SubPremiseLevel":"string", | |||
"SubPremiseLevelType":"string", | |||
"SubPremiseLevelNumber":"string", | |||
"SubBuilding":"string", | |||
"SubBuildingType":"string", | |||
"SubBuildingNumber":"string", | |||
"UTC":"string", | |||
"DST":"string", | |||
"DeliveryPointSuffix":"string", | |||
"CensusKey":"string", | |||
"Extras":[{ | |||
... | |||
}] | |||
}, | }, | ||
{ | { | ||
| Line 135: | Line 150: | ||
"AdministrativeArea":"string", | "AdministrativeArea":"string", | ||
"PostalCode":"string", | "PostalCode":"string", | ||
"PostalCodeType":"string", | |||
"AddressType":"string", | "AddressType":"string", | ||
"AddressKey":"string", | "AddressKey":"string", | ||
| Line 142: | Line 158: | ||
"CountryISO3166_1_Alpha3":"string", | "CountryISO3166_1_Alpha3":"string", | ||
"CountryISO3166_1_Numeric":"string", | "CountryISO3166_1_Numeric":"string", | ||
"CountrySubdivisionCode":"string", | |||
"Thoroughfare":"string", | "Thoroughfare":"string", | ||
"ThoroughfarePreDirection":"string", | "ThoroughfarePreDirection":"string", | ||
| Line 161: | Line 178: | ||
"PostBox":"string", | "PostBox":"string", | ||
"Latitude":"string", | "Latitude":"string", | ||
"Longitude":"string" | "Longitude":"string", | ||
"DeliveryIndicator":"string", | |||
"MelissaAddressKey":"string", | |||
"MelissaAddressKeyBase":"string", | |||
"PostOfficeLocation":"string", | |||
"SubPremiseLevel":"string", | |||
"SubPremiseLevelType":"string", | |||
"SubPremiseLevelNumber":"string", | |||
"SubBuilding":"string", | |||
"SubBuildingType":"string", | |||
"SubBuildingNumber":"string", | |||
"UTC":"string", | |||
"DST":"string", | |||
"DeliveryPointSuffix":"string", | |||
"CensusKey":"string", | |||
"Extras":[{ | |||
... | |||
}] | |||
}, | }, | ||
{ | { | ||
Latest revision as of 17:57, 16 September 2020
| Global Address Navigation | |||||||
|---|---|---|---|---|---|---|---|
| |||||||
| |||||||
| |||||||
| |||||||
| Sample Code |
JSON Batch Request
A maximum of up to 100 records per request can be sent. You must have "Accept: application/json" in the http header.
{
"TransmissionReference":"string",
"CustomerID":"string",
"Options":"string",
"Records":[{
"RecordID":"string",
"Organization":"string",
"AddressLine1":"string",
"AddressLine2":"string",
"AddressLine3":"string",
"AddressLine4":"string",
"AddressLine5":"string",
"AddressLine6":"string",
"AddressLine7":"string",
"AddressLine8":"string",
"DoubleDependentLocality":"string",
"DependentLocality":"string",
"Locality":"string",
"SubAdministrativeArea":"string",
"AdministrativeArea":"string",
"PostalCode":"string",
"SubNationalArea":"string",
"Country":"string"
},
{
"RecordID":"string",
"Organization":"string",
"AddressLine1":"string",
"AddressLine2":"string",
"AddressLine3":"string",
"AddressLine4":"string",
"AddressLine5":"string",
"AddressLine6":"string",
"AddressLine7":"string",
"AddressLine8":"string",
"DoubleDependentLocality":"string",
"DependentLocality":"string",
"Locality":"string",
"SubAdministrativeArea":"string",
"AdministrativeArea":"string",
"PostalCode":"string",
"SubNationalArea":"string",
"Country":"string"
}]
}
JSON Batch Response
{
"Version":"string",
"TransmissionReference":"string",
"TransmissionResults":"string",
"TotalRecords":"string",
"Records":[{
"RecordID":"string",
"Results":"string",
"FormattedAddress":"string",
"Organization":"string",
"AddressLine1":"string",
"AddressLine2":"string",
"AddressLine3":"string",
"AddressLine4":"string",
"AddressLine5":"string",
"AddressLine6":"string",
"AddressLine7":"string",
"AddressLine8":"string",
"SubPremises":"string",
"DoubleDependentLocality":"string",
"DependentLocality":"string",
"Locality":"string",
"SubAdministrativeArea":"string",
"AdministrativeArea":"string",
"PostalCode":"string",
"PostalCodeType":"string",
"AddressType":"string",
"AddressKey":"string",
"SubNationalArea":"string",
"CountryName":"string",
"CountryISO3166_1_Alpha2":"string",
"CountryISO3166_1_Alpha3":"string",
"CountryISO3166_1_Numeric":"string",
"CountrySubdivisionCode":"string",
"Thoroughfare":"string",
"ThoroughfarePreDirection":"string",
"ThoroughfareLeadingType":"string",
"ThoroughfareName":"string",
"ThoroughfareTrailingType":"string",
"ThoroughfarePostDirection":"string",
"DependentThoroughfare":"string",
"DependentThoroughfarePreDirection":"string",
"DependentThoroughfareLeadingType":"string",
"DependentThoroughfareName":"string",
"DependentThoroughfareTrailingType":"string",
"DependentThoroughfarePostDirection":"string",
"Building":"string",
"PremisesType":"string",
"PremisesNumber":"string",
"SubPremisesType":"string",
"SubPremisesNumber":"string",
"PostBox":"string",
"Latitude":"string",
"Longitude":"string",
"DeliveryIndicator":"string",
"MelissaAddressKey":"string",
"MelissaAddressKeyBase":"string",
"PostOfficeLocation":"string",
"SubPremiseLevel":"string",
"SubPremiseLevelType":"string",
"SubPremiseLevelNumber":"string",
"SubBuilding":"string",
"SubBuildingType":"string",
"SubBuildingNumber":"string",
"UTC":"string",
"DST":"string",
"DeliveryPointSuffix":"string",
"CensusKey":"string",
"Extras":[{
...
}]
},
{
"RecordID":"string",
"Results":"string",
"FormattedAddress":"string",
"Organization":"string",
"AddressLine1":"string",
"AddressLine2":"string",
"AddressLine3":"string",
"AddressLine4":"string",
"AddressLine5":"string",
"AddressLine6":"string",
"AddressLine7":"string",
"AddressLine8":"string",
"SubPremises":"string",
"DoubleDependentLocality":"string",
"DependentLocality":"string",
"Locality":"string",
"SubAdministrativeArea":"string",
"AdministrativeArea":"string",
"PostalCode":"string",
"PostalCodeType":"string",
"AddressType":"string",
"AddressKey":"string",
"SubNationalArea":"string",
"CountryName":"string",
"CountryISO3166_1_Alpha2":"string",
"CountryISO3166_1_Alpha3":"string",
"CountryISO3166_1_Numeric":"string",
"CountrySubdivisionCode":"string",
"Thoroughfare":"string",
"ThoroughfarePreDirection":"string",
"ThoroughfareLeadingType":"string",
"ThoroughfareName":"string",
"ThoroughfareTrailingType":"string",
"ThoroughfarePostDirection":"string",
"DependentThoroughfare":"string",
"DependentThoroughfarePreDirection":"string",
"DependentThoroughfareLeadingType":"string",
"DependentThoroughfareName":"string",
"DependentThoroughfareTrailingType":"string",
"DependentThoroughfarePostDirection":"string",
"Building":"string",
"PremisesType":"string",
"PremisesNumber":"string",
"SubPremisesType":"string",
"SubPremisesNumber":"string",
"PostBox":"string",
"Latitude":"string",
"Longitude":"string",
"DeliveryIndicator":"string",
"MelissaAddressKey":"string",
"MelissaAddressKeyBase":"string",
"PostOfficeLocation":"string",
"SubPremiseLevel":"string",
"SubPremiseLevelType":"string",
"SubPremiseLevelNumber":"string",
"SubBuilding":"string",
"SubBuildingType":"string",
"SubBuildingNumber":"string",
"UTC":"string",
"DST":"string",
"DeliveryPointSuffix":"string",
"CensusKey":"string",
"Extras":[{
...
}]
},
{
...
}]
}