Difference between revisions of "Global Address Verification:Batch JSON"

From Melissa Data Wiki
Jump to navigation Jump to search
 
Line 83: Line 83:
 
     "AdministrativeArea":"string",
 
     "AdministrativeArea":"string",
 
     "PostalCode":"string",
 
     "PostalCode":"string",
 +
    "PostalCodeType":"string",
 
     "AddressType":"string",
 
     "AddressType":"string",
 
     "AddressKey":"string",
 
     "AddressKey":"string",
Line 90: 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 109: 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 131: Line 150:
 
     "AdministrativeArea":"string",
 
     "AdministrativeArea":"string",
 
     "PostalCode":"string",
 
     "PostalCode":"string",
 +
    "PostalCodeType":"string",
 
     "AddressType":"string",
 
     "AddressType":"string",
 
     "AddressKey":"string",
 
     "AddressKey":"string",
Line 138: 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 157: 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 Verification

Global Address Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
REST JSONP
REST XML
Batch JSON
Batch SOAP
Batch XML
Result Codes
Result Code Use
Global Address Verification Result Codes
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":[{
      ...
    }]
  },
  {
    ...
  }]
}