Global Address Verification:Batch SOAP: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{GlobalAddressVerificationNav |ExampleCollapse= }} {{CustomTOC}} ==SOAP Batch Request== A maximum of up to 100 records per request can be sent. <pre> ReqInternational.Reco..." |
No edit summary |
||
(4 intermediate revisions by the same user not shown) | |||
Line 5: | Line 5: | ||
{{CustomTOC}} | {{CustomTOC}} | ||
==SOAP WSDL== | |||
<pre> | |||
https://address.melissadata.net/v3/SOAP/GlobalAddress?wsdl | |||
https://address.melissadata.net/v3/SOAP/GlobalAddress?singleWsdl | |||
</pre> | |||
==SOAP Batch Request== | ==SOAP Batch Request== | ||
A maximum of up to 100 records per request can be sent. | A maximum of up to 100 records per request can be sent. | ||
<pre> | |||
<?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> | |||
</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> | <pre> | ||
Content-Type: text/xml; charset=utf-8 | |||
SOAPAction: "urn:mdGlobalAddress/AddressCheckSoap/doGlobalAddress" | |||
</pre> | </pre> | ||
Line 41: | Line 87: | ||
==SOAP Batch Response== | ==SOAP Batch Response== | ||
<pre> | <pre> | ||
<?xml version="1.0"?> | |||
string | <Response xmlns=urn:mdGlobalAddress xmlns:i=http://www.w3.org/2001/XMLSchema-instance> | ||
string | <Version>string</Version> | ||
string | <TransmissionReference>string</TransmissionReference> | ||
<TransmissionResults>string</TransmissionResults> | |||
string | <TotalRecords>string</TotalRecords> | ||
string | <Records> | ||
string | <ResponseRecord> | ||
string | <RecordID>string</RecordID> | ||
string | <Results>string</Results> | ||
string | <FormattedAddress>string</FormattedAddress> | ||
string | <Organization>string</Organization> | ||
string | <AddressLine1>string</AddressLine1> | ||
string | <AddressLine2>string</AddressLine2> | ||
string | <AddressLine3>string</AddressLine3> | ||
string | <AddressLine4>string</AddressLine4> | ||
string | <AddressLine5>string</AddressLine5> | ||
string | <AddressLine6>string</AddressLine6> | ||
string | <AddressLine7>string</AddressLine7> | ||
string | <AddressLine8>string</AddressLine8> | ||
string | <SubPremises>string</SubPremises> | ||
string | <DoubleDependentLocality>string</DoubleDependentLocality> | ||
string | <DependentLocality>string</DependentLocality> | ||
string | <Locality>string</Locality> | ||
string | <SubAdministrativeArea>string</SubAdministrativeArea> | ||
string | <AdministrativeArea>string</AdministrativeArea> | ||
string | <PostalCode>string</PostalCode> | ||
string | <PostalCodeType>string</PostalCodeType> | ||
string | <AddressType>string</AddressType> | ||
string | <AddressKey>string</AddressKey> | ||
string | <SubNationalArea>string</SubNationalArea> | ||
string | <CountryName>string</CountryName> | ||
string | <CountryISO3166_1_Alpha2>string</CountryISO3166_1_Alpha2> | ||
string | <CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3> | ||
string | <CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric> | ||
string | <CountrySubdivisionCode>string</CountrySubdivisionCode> | ||
string | <Thoroughfare>string</Thoroughfare> | ||
string | <ThoroughfarePreDirection>string</ThoroughfarePreDirection> | ||
string | <ThoroughfareLeadingType>string</ThoroughfareLeadingType> | ||
string | <ThoroughfareName>string</ThoroughfareName> | ||
string | <ThoroughfareTrailingType>string</ThoroughfareTrailingType> | ||
string | <ThoroughfarePostDirection>string</ThoroughfarePostDirection> | ||
string | <DependentThoroughfare>string</DependentThoroughfare> | ||
string | <DependentThoroughfarePreDirection>string</DependentThoroughfarePreDirection> | ||
string | <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> | |||
</pre> | </pre> | ||
Latest revision as of 16:46, 13 February 2024
Global Address Navigation | |||||||
---|---|---|---|---|---|---|---|
| |||||||
| |||||||
| |||||||
| |||||||
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>