Global Address Verification:Batch SOAP: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:
==SOAP WSDL==
==SOAP WSDL==
<pre>
<pre>
http://address.melissadata.net/v3/SOAP/GlobalAddress?wsdl
https://address.melissadata.net/v3/SOAP/GlobalAddress?wsdl
http://address.melissadata.net/v3/SOAP/GlobalAddress?singleWsdl
https://address.melissadata.net/v3/SOAP/GlobalAddress?singleWsdl
</pre>
</pre>


Line 17: Line 17:


<pre>
<pre>
<?xml version="1.0"?>
<?xml version="1.0" encoding="utf-8"?>
<Request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<doGlobalAddress xmlns="urn:mdGlobalAddress">
<Request>
   <TransmissionReference xmlns="urn:mdGlobalAddress" />
   <TransmissionReference xmlns="urn:mdGlobalAddress" />
   <CustomerID xmlns="urn:mdGlobalAddress">string</CustomerID>
   <CustomerID xmlns="urn:mdGlobalAddress">string</CustomerID>
Line 24: Line 27:
   <Records xmlns="urn:mdGlobalAddress">
   <Records xmlns="urn:mdGlobalAddress">
     <RequestRecord>
     <RequestRecord>
       <RecordID>string</RecordID>
       <RecordID>123</RecordID>
       <Organization />
       <Organization />
       <AddressLine1>string</AddressLine1>
       <AddressLine1>string</AddressLine1>
Line 42: Line 45:
       <SubNationalArea />
       <SubNationalArea />
       <Country>string</Country>
       <Country>string</Country>
       <RecordOptions xsi:nil="true" />
       <RecordOptions />
     </RequestRecord>
     </RequestRecord>
     <RequestRecord>
     <RequestRecord>
       <RecordID>string</RecordID>
       <RecordID>1234</RecordID>
       <Organization />
       <Organization />
       <AddressLine1>string</AddressLine1>
       <AddressLine1>string</AddressLine1>
Line 63: Line 66:
       <SubNationalArea />
       <SubNationalArea />
       <Country>string</Country>
       <Country>string</Country>
       <RecordOptions xsi:nil="true" />
       <RecordOptions />
    </RequestRecord>
    <RequestRecord>
      ...
     </RequestRecord>
     </RequestRecord>
   </Records>
   </Records>
</Request>
</Request>
</doGlobalAddress>
</soap:Body>
</soap:Envelope>
</pre>
==Application==
It is recommended that users use a SOAP toolkit that will automatically read the SOAP wsdl and generate all the necessary headers, namespaces, and structures. However, if you are dealing with raw SOAP request,  you may have to add the following to your http header depending on the application you are using:
<pre>
Content-Type: text/xml; charset=utf-8
SOAPAction: "urn:mdGlobalAddress/AddressCheckSoap/doGlobalAddress"
</pre>
</pre>




==XML Batch Response==
==SOAP Batch Response==
<pre>
<pre>
<?xml version="1.0"?>
<?xml version="1.0"?>
Line 102: Line 114:
       <AdministrativeArea>string</AdministrativeArea>
       <AdministrativeArea>string</AdministrativeArea>
       <PostalCode>string</PostalCode>
       <PostalCode>string</PostalCode>
      <PostalCodeType>string</PostalCodeType>
       <AddressType>string</AddressType>
       <AddressType>string</AddressType>
       <AddressKey>string</AddressKey>
       <AddressKey>string</AddressKey>
Line 109: Line 122:
       <CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3>
       <CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3>
       <CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric>
       <CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric>
      <CountrySubdivisionCode>string</CountrySubdivisionCode>
       <Thoroughfare>string</Thoroughfare>
       <Thoroughfare>string</Thoroughfare>
       <ThoroughfarePreDirection>string</ThoroughfarePreDirection>
       <ThoroughfarePreDirection>string</ThoroughfarePreDirection>
Line 129: Line 143:
       <Latitude>string</Latitude>
       <Latitude>string</Latitude>
       <Longitude>string</Longitude>
       <Longitude>string</Longitude>
      <DeliveryIndicator>string</DeliveryIndicator>
      <MelissaAddressKey>string</MelissaAddressKey>
      <MelissaAddressKeyBase>string</MelissaAddressKeyBase>
      <PostOfficeLocation>string</PostOfficeLocation>
      <SubPremiseLevel>string</SubPremiseLevel>
      <SubPremiseLevelType>string</SubPremiseLevelType>
      <SubPremiseLevelNumber>string</SubPremiseLevelNumber>
      <SubBuilding>string</SubBuilding>
      <SubBuildingType>string</SubBuildingType>
      <SubBuildingNumber>string</SubBuildingNumber>
      <UTC>string</UTC>
      <DST>string</DST>
      <DeliveryPointSuffix>string</DeliveryPointSuffix>
      <CensusKey>string</CensusKey>
      <Extras/>
     </ResponseRecord>
     </ResponseRecord>
     <ResponseRecord>
     <ResponseRecord>
Line 150: Line 179:
       <AdministrativeArea>string</AdministrativeArea>
       <AdministrativeArea>string</AdministrativeArea>
       <PostalCode>string</PostalCode>
       <PostalCode>string</PostalCode>
      <PostalCodeType>string</PostalCodeType>
       <AddressType>string</AddressType>
       <AddressType>string</AddressType>
       <AddressKey>string</AddressKey>
       <AddressKey>string</AddressKey>
Line 157: Line 187:
       <CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3>
       <CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3>
       <CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric>
       <CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric>
      <CountrySubdivisionCode>string</CountrySubdivisionCode>
       <Thoroughfare>string</Thoroughfare>
       <Thoroughfare>string</Thoroughfare>
       <ThoroughfarePreDirection>string</ThoroughfarePreDirection>
       <ThoroughfarePreDirection>string</ThoroughfarePreDirection>
Line 177: Line 208:
       <Latitude>string</Latitude>
       <Latitude>string</Latitude>
       <Longitude>string</Longitude>
       <Longitude>string</Longitude>
      <DeliveryIndicator>string</DeliveryIndicator>
      <MelissaAddressKey>string</MelissaAddressKey>
      <MelissaAddressKeyBase>string</MelissaAddressKeyBase>
      <PostOfficeLocation>string</PostOfficeLocation>
      <SubPremiseLevel>string</SubPremiseLevel>
      <SubPremiseLevelType>string</SubPremiseLevelType>
      <SubPremiseLevelNumber>string</SubPremiseLevelNumber>
      <SubBuilding>string</SubBuilding>
      <SubBuildingType>string</SubBuildingType>
      <SubBuildingNumber>string</SubBuildingNumber>
      <UTC>string</UTC>
      <DST>string</DST>
      <DeliveryPointSuffix>string</DeliveryPointSuffix>
      <CensusKey>string</CensusKey>
      <Extras/>
     </ResponseRecord>
     </ResponseRecord>
     <ResponseRecord>
     <ResponseRecord>

Latest revision as of 16:46, 13 February 2024

← 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



SOAP WSDL

https://address.melissadata.net/v3/SOAP/GlobalAddress?wsdl
https://address.melissadata.net/v3/SOAP/GlobalAddress?singleWsdl


SOAP Batch Request

A maximum of up to 100 records per request can be sent.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<doGlobalAddress xmlns="urn:mdGlobalAddress">
<Request>
  <TransmissionReference xmlns="urn:mdGlobalAddress" />
  <CustomerID xmlns="urn:mdGlobalAddress">string</CustomerID>
  <Options xmlns="urn:mdGlobalAddress" />
  <Records xmlns="urn:mdGlobalAddress">
    <RequestRecord>
      <RecordID>123</RecordID>
      <Organization />
      <AddressLine1>string</AddressLine1>
      <AddressLine2 />
      <AddressLine3 />
      <AddressLine4 />
      <AddressLine5 />
      <AddressLine6 />
      <AddressLine7 />
      <AddressLine8 />
      <DoubleDependentLocality />
      <DependentLocality />
      <Locality />
      <SubAdministrativeArea />
      <AdministrativeArea />
      <PostalCode>string</PostalCode>
      <SubNationalArea />
      <Country>string</Country>
      <RecordOptions />
    </RequestRecord>
    <RequestRecord>
      <RecordID>1234</RecordID>
      <Organization />
      <AddressLine1>string</AddressLine1>
      <AddressLine2 />
      <AddressLine3 />
      <AddressLine4 />
      <AddressLine5 />
      <AddressLine6 />
      <AddressLine7 />
      <AddressLine8 />
      <DoubleDependentLocality />
      <DependentLocality />
      <Locality />
      <SubAdministrativeArea />
      <AdministrativeArea />
      <PostalCode>string</PostalCode>
      <SubNationalArea />
      <Country>string</Country>
      <RecordOptions />
    </RequestRecord>
  </Records>
</Request>
</doGlobalAddress>
</soap:Body>
</soap:Envelope>


Application

It is recommended that users use a SOAP toolkit that will automatically read the SOAP wsdl and generate all the necessary headers, namespaces, and structures. However, if you are dealing with raw SOAP request, you may have to add the following to your http header depending on the application you are using:

Content-Type: text/xml; charset=utf-8
SOAPAction: "urn:mdGlobalAddress/AddressCheckSoap/doGlobalAddress"


SOAP Batch Response

<?xml version="1.0"?>
<Response xmlns=urn:mdGlobalAddress xmlns:i=http://www.w3.org/2001/XMLSchema-instance>
  <Version>string</Version>
  <TransmissionReference>string</TransmissionReference>
  <TransmissionResults>string</TransmissionResults>
  <TotalRecords>string</TotalRecords>
  <Records>
    <ResponseRecord>
      <RecordID>string</RecordID>
      <Results>string</Results>
      <FormattedAddress>string</FormattedAddress>
      <Organization>string</Organization>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <AddressLine3>string</AddressLine3>
      <AddressLine4>string</AddressLine4>
      <AddressLine5>string</AddressLine5>
      <AddressLine6>string</AddressLine6>
      <AddressLine7>string</AddressLine7>
      <AddressLine8>string</AddressLine8>
      <SubPremises>string</SubPremises>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <DependentLocality>string</DependentLocality>
      <Locality>string</Locality>
      <SubAdministrativeArea>string</SubAdministrativeArea>
      <AdministrativeArea>string</AdministrativeArea>
      <PostalCode>string</PostalCode>
      <PostalCodeType>string</PostalCodeType>
      <AddressType>string</AddressType>
      <AddressKey>string</AddressKey>
      <SubNationalArea>string</SubNationalArea>
      <CountryName>string</CountryName>
      <CountryISO3166_1_Alpha2>string</CountryISO3166_1_Alpha2>
      <CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3>
      <CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric>
      <CountrySubdivisionCode>string</CountrySubdivisionCode>
      <Thoroughfare>string</Thoroughfare>
      <ThoroughfarePreDirection>string</ThoroughfarePreDirection>
      <ThoroughfareLeadingType>string</ThoroughfareLeadingType>
      <ThoroughfareName>string</ThoroughfareName>
      <ThoroughfareTrailingType>string</ThoroughfareTrailingType>
      <ThoroughfarePostDirection>string</ThoroughfarePostDirection>
      <DependentThoroughfare>string</DependentThoroughfare>
      <DependentThoroughfarePreDirection>string</DependentThoroughfarePreDirection>
      <DependentThoroughfareLeadingType>string</DependentThoroughfareLeadingType>
      <DependentThoroughfareName>string</DependentThoroughfareName>
      <DependentThoroughfareTrailingType>string</DependentThoroughfareTrailingType>
      <DependentThoroughfarePostDirection>string</DependentThoroughfarePostDirection>
      <Building>string</Building>
      <PremisesType>string</PremisesType>
      <PremisesNumber>string</PremisesNumber>
      <SubPremisesType>string</SubPremisesType>
      <SubPremisesNumber>string</SubPremisesNumber>
      <PostBox>string</PostBox>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <DeliveryIndicator>string</DeliveryIndicator>
      <MelissaAddressKey>string</MelissaAddressKey>
      <MelissaAddressKeyBase>string</MelissaAddressKeyBase>
      <PostOfficeLocation>string</PostOfficeLocation>
      <SubPremiseLevel>string</SubPremiseLevel>
      <SubPremiseLevelType>string</SubPremiseLevelType>
      <SubPremiseLevelNumber>string</SubPremiseLevelNumber>
      <SubBuilding>string</SubBuilding>
      <SubBuildingType>string</SubBuildingType>
      <SubBuildingNumber>string</SubBuildingNumber>
      <UTC>string</UTC>
      <DST>string</DST>
      <DeliveryPointSuffix>string</DeliveryPointSuffix>
      <CensusKey>string</CensusKey>
      <Extras/>
    </ResponseRecord>
    <ResponseRecord>
      <RecordID>string</RecordID>
      <Results>string</Results>
      <FormattedAddress>string</FormattedAddress>
      <Organization>string</Organization>
      <AddressLine1>string</AddressLine1>
      <AddressLine2>string</AddressLine2>
      <AddressLine3>string</AddressLine3>
      <AddressLine4>string</AddressLine4>
      <AddressLine5>string</AddressLine5>
      <AddressLine6>string</AddressLine6>
      <AddressLine7>string</AddressLine7>
      <AddressLine8>string</AddressLine8>
      <SubPremises>string</SubPremises>
      <DoubleDependentLocality>string</DoubleDependentLocality>
      <DependentLocality>string</DependentLocality>
      <Locality>string</Locality>
      <SubAdministrativeArea>string</SubAdministrativeArea>
      <AdministrativeArea>string</AdministrativeArea>
      <PostalCode>string</PostalCode>
      <PostalCodeType>string</PostalCodeType>
      <AddressType>string</AddressType>
      <AddressKey>string</AddressKey>
      <SubNationalArea>string</SubNationalArea>
      <CountryName>string</CountryName>
      <CountryISO3166_1_Alpha2>string</CountryISO3166_1_Alpha2>
      <CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3>
      <CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric>
      <CountrySubdivisionCode>string</CountrySubdivisionCode>
      <Thoroughfare>string</Thoroughfare>
      <ThoroughfarePreDirection>string</ThoroughfarePreDirection>
      <ThoroughfareLeadingType>string</ThoroughfareLeadingType>
      <ThoroughfareName>string</ThoroughfareName>
      <ThoroughfareTrailingType>string</ThoroughfareTrailingType>
      <ThoroughfarePostDirection>string</ThoroughfarePostDirection>
      <DependentThoroughfare>string</DependentThoroughfare>
      <DependentThoroughfarePreDirection>string</DependentThoroughfarePreDirection>
      <DependentThoroughfareLeadingType>string</DependentThoroughfareLeadingType>
      <DependentThoroughfareName>string</DependentThoroughfareName>
      <DependentThoroughfareTrailingType>string</DependentThoroughfareTrailingType>
      <DependentThoroughfarePostDirection>string</DependentThoroughfarePostDirection>
      <Building>string</Building>
      <PremisesType>string</PremisesType>
      <PremisesNumber>string</PremisesNumber>
      <SubPremisesType>string</SubPremisesType>
      <SubPremisesNumber>string</SubPremisesNumber>
      <PostBox>string</PostBox>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <DeliveryIndicator>string</DeliveryIndicator>
      <MelissaAddressKey>string</MelissaAddressKey>
      <MelissaAddressKeyBase>string</MelissaAddressKeyBase>
      <PostOfficeLocation>string</PostOfficeLocation>
      <SubPremiseLevel>string</SubPremiseLevel>
      <SubPremiseLevelType>string</SubPremiseLevelType>
      <SubPremiseLevelNumber>string</SubPremiseLevelNumber>
      <SubBuilding>string</SubBuilding>
      <SubBuildingType>string</SubBuildingType>
      <SubBuildingNumber>string</SubBuildingNumber>
      <UTC>string</UTC>
      <DST>string</DST>
      <DeliveryPointSuffix>string</DeliveryPointSuffix>
      <CensusKey>string</CensusKey>
      <Extras/>
    </ResponseRecord>
    <ResponseRecord>
      ...
    </ResponseRecord>
  </Records>
</Response>