SmartMover V3:REST JSON: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
Created page with "{{SmartMoverV3Nav |ExampleCollapse= }} {{CustomTOC}} ==REST Request== <pre> https://smartmover.melissadata.net/v3/WEB/SmartMover/doSmartMover ?t={Transmission Reference} &i..."
 
No edit summary
 
Line 13: Line 13:
&jobid={Job ID}
&jobid={Job ID}
&pafid={PAF ID}
&pafid={PAF ID}
&act={Action}
&act={Actions}
&cols={Columns}
&cols={Columns}
&opt={Options}
&opt={Options}
Line 41: Line 41:
<pre>
<pre>
{
{
     "CASSReportLink": "string",
     "CASSReportLink":"string",
     "NCOAReportLink": "string",
     "NCOAReportLink":"string",
     "Records": [
     "Records":[
         {
         {
             "AddressDeliveryInstallation": "string",
             "AddressDeliveryInstallation":"string",
             "AddressExtras": "string",
             "AddressExtras":"string",
             "AddressHouseNumber": "string",
             "AddressHouseNumber":"string",
             "AddressKey": "string",
             "AddressKey":"string",
             "AddressLine1": "string",
             "AddressLine1":"string",
             "AddressLine2": "string",
             "AddressLine2":"string",
             "AddressLockBox": "string",
             "AddressLockBox":"string",
             "AddressPostDirection": "string",
             "AddressPostDirection":"string",
             "AddressPreDirection": "string",
             "AddressPreDirection":"string",
             "AddressPrivateMailboxName": "string",
             "AddressPrivateMailboxName":"string",
             "AddressPrivateMailboxRange": "string",
             "AddressPrivateMailboxRange":"string",
             "AddressRouteService": "string",
             "AddressRouteService":"string",
             "AddressStreetName": "string",
             "AddressStreetName":"string",
             "AddressStreetSuffix": "string",
             "AddressStreetSuffix":"string",
             "AddressSuiteName": "string",
             "AddressSuiteName":"string",
             "AddressSuiteNumber": "string",
             "AddressSuiteNumber":"string",
             "AddressTypeCode": "string",
             "AddressTypeCode":"string",
             "BaseMelissaAddressKey": "string",
             "BaseMelissaAddressKey":"string",
             "CarrierRoute": "string",
             "CarrierRoute":"string",
             "City": "string",
             "City":"string",
             "CityAbbreviation": "string",
             "CityAbbreviation":"string",
             "CompanyName": "string",
             "CompanyName":"string",
             "CountryCode": "string",
             "CountryCode":"string",
             "CountryName": "string",
             "CountryName":"string",
             "DPVFootNotes": "string",
             "DPVFootNotes":"string",
             "DeliveryIndicator": "string",
             "DeliveryIndicator":"string",
             "DeliveryPointCheckDigit": "string",
             "DeliveryPointCheckDigit":"string",
             "DeliveryPointCode": "string",
             "DeliveryPointCode":"string",
             "MelissaAddressKey": "string",
             "MelissaAddressKey":"string",
             "MoveEffectiveDate": "string",
             "MoveEffectiveDate":"string",
             "MoveReturnCode": "string",
             "MoveReturnCode":"string",
             "MoveTypeCode": "string",
             "MoveTypeCode":"string",
             "NameFirst": "string",
             "NameFirst":"string",
             "NameFull": "string",
             "NameFull":"string",
             "NameLast": "string",
             "NameLast":"string",
             "NameMiddle": "string",
             "NameMiddle":"string",
             "NamePrefix": "string",
             "NamePrefix":"string",
             "NameSuffix": "string",
             "NameSuffix":"string",
             "OriginalAddressLine1": "string",
             "OriginalAddressLine1":"string",
             "OriginalAddressLine2": "string",
             "OriginalAddressLine2":"string",
             "OriginalCity": "string",
             "OriginalCity":"string",
             "OriginalCityAbbreviation": "string",
             "OriginalCityAbbreviation":"string",
             "OriginalCountryCode": "string",
             "OriginalCountryCode":"string",
             "OriginalPlus4": "string",
             "OriginalPlus4":"string",
             "OriginalPostalCode": "string",
             "OriginalPostalCode":"string",
             "OriginalPrivateMailbox": "string",
             "OriginalPrivateMailbox":"string",
             "OriginalResults": "string",
             "OriginalResults":"string",
             "OriginalState": "string",
             "OriginalState":"string",
             "OriginalStateName": "string",
             "OriginalStateName":"string",
             "OriginalSuite": "string",
             "OriginalSuite":"string",
             "OriginalUrbanization": "string",
             "OriginalUrbanization":"string",
             "Plus4": "string",
             "Plus4":"string",
             "PostalCode": "string",
             "PostalCode":"string",
             "PrivateMailbox": "string",
             "PrivateMailbox":"string",
             "RecordID": "string",
             "RecordID":"string",
             "Results": "string",
             "Results":"string",
             "StandardizedAddressLine1": "string",
             "StandardizedAddressLine1":"string",
             "StandardizedAddressLine2": "string",
             "StandardizedAddressLine2":"string",
             "StandardizedBaseMelissaAddressKey": "string",
             "StandardizedBaseMelissaAddressKey":"string",
             "StandardizedCarrierRoute": "string",
             "StandardizedCarrierRoute":"string",
             "StandardizedCity": "string",
             "StandardizedCity":"string",
             "StandardizedCityAbbreviation": "string",
             "StandardizedCityAbbreviation":"string",
             "StandardizedCountryCode": "string",
             "StandardizedCountryCode":"string",
             "StandardizedDeliveryIndicator": "string",
             "StandardizedDeliveryIndicator":"string",
             "StandardizedDeliveryPointCheckDigit": "string",
             "StandardizedDeliveryPointCheckDigit":"string",
             "StandardizedDeliveryPointCode": "string",
             "StandardizedDeliveryPointCode":"string",
             "StandardizedMelissaAddressKey": "string",
             "StandardizedMelissaAddressKey":"string",
             "StandardizedPlus4": "string",
             "StandardizedPlus4":"string",
             "StandardizedPostalCode": "string",
             "StandardizedPostalCode":"string",
             "StandardizedPrivateMailbox": "string",
             "StandardizedPrivateMailbox":"string",
             "StandardizedResults": "string",
             "StandardizedResults":"string",
             "StandardizedState": "string",
             "StandardizedState":"string",
             "StandardizedStateName": "string",
             "StandardizedStateName":"string",
             "StandardizedSuite": "string",
             "StandardizedSuite":"string",
             "StandardizedUrbanization": "string",
             "StandardizedUrbanization":"string",
             "State": "string",
             "State":"string",
             "StateName": "string",
             "StateName":"string",
             "Suite": "string",
             "Suite":"string",
             "Urbanization": "string"
             "Urbanization":"string"
         }
         }
     ],
     ],
     "TotalRecords": "string",
     "TotalRecords":"string",
     "TransmissionReference": "string",
     "TransmissionReference":"string",
     "TransmissionResults": "string",
     "TransmissionResults":"string",
     "Version": "string"
     "Version":"string"
}
}
</pre>
</pre>

Latest revision as of 21:07, 18 January 2018

← SmartMover

SmartMover Navigation
Introduction
Licensing
Transitioning From V2b
Input/Output
Request Fields
Response Fields
Examples
REST JSON
JSON
XML
Result Codes
Result Code Use
SmartMover Result Codes
Sample Code



REST Request

https://smartmover.melissadata.net/v3/WEB/SmartMover/doSmartMover
?t={Transmission Reference}
&id={License Key}
&jobid={Job ID}
&pafid={PAF ID}
&act={Actions}
&cols={Columns}
&opt={Options}
&List={List Name}
&comp={Company}
&full={Name Full}
&first={Name First}
&Middle={Name Middle}
&Namepre={Name Prefix}
&Namesfx={Name Suffix}
&last={Name Last}
&u={Urbanization}
&a1={Address Line 1}
&a2={Address Line 2}
&ste={Suite}
&pmb={Private Mailbox}
&city={City}
&state={State}
&postal={Postal Code}
&plus4={Plus4}
&ctry={Country}
&format={Format}


JSON Response

{
    "CASSReportLink":"string",
    "NCOAReportLink":"string",
    "Records":[
        {
            "AddressDeliveryInstallation":"string",
            "AddressExtras":"string",
            "AddressHouseNumber":"string",
            "AddressKey":"string",
            "AddressLine1":"string",
            "AddressLine2":"string",
            "AddressLockBox":"string",
            "AddressPostDirection":"string",
            "AddressPreDirection":"string",
            "AddressPrivateMailboxName":"string",
            "AddressPrivateMailboxRange":"string",
            "AddressRouteService":"string",
            "AddressStreetName":"string",
            "AddressStreetSuffix":"string",
            "AddressSuiteName":"string",
            "AddressSuiteNumber":"string",
            "AddressTypeCode":"string",
            "BaseMelissaAddressKey":"string",
            "CarrierRoute":"string",
            "City":"string",
            "CityAbbreviation":"string",
            "CompanyName":"string",
            "CountryCode":"string",
            "CountryName":"string",
            "DPVFootNotes":"string",
            "DeliveryIndicator":"string",
            "DeliveryPointCheckDigit":"string",
            "DeliveryPointCode":"string",
            "MelissaAddressKey":"string",
            "MoveEffectiveDate":"string",
            "MoveReturnCode":"string",
            "MoveTypeCode":"string",
            "NameFirst":"string",
            "NameFull":"string",
            "NameLast":"string",
            "NameMiddle":"string",
            "NamePrefix":"string",
            "NameSuffix":"string",
            "OriginalAddressLine1":"string",
            "OriginalAddressLine2":"string",
            "OriginalCity":"string",
            "OriginalCityAbbreviation":"string",
            "OriginalCountryCode":"string",
            "OriginalPlus4":"string",
            "OriginalPostalCode":"string",
            "OriginalPrivateMailbox":"string",
            "OriginalResults":"string",
            "OriginalState":"string",
            "OriginalStateName":"string",
            "OriginalSuite":"string",
            "OriginalUrbanization":"string",
            "Plus4":"string",
            "PostalCode":"string",
            "PrivateMailbox":"string",
            "RecordID":"string",
            "Results":"string",
            "StandardizedAddressLine1":"string",
            "StandardizedAddressLine2":"string",
            "StandardizedBaseMelissaAddressKey":"string",
            "StandardizedCarrierRoute":"string",
            "StandardizedCity":"string",
            "StandardizedCityAbbreviation":"string",
            "StandardizedCountryCode":"string",
            "StandardizedDeliveryIndicator":"string",
            "StandardizedDeliveryPointCheckDigit":"string",
            "StandardizedDeliveryPointCode":"string",
            "StandardizedMelissaAddressKey":"string",
            "StandardizedPlus4":"string",
            "StandardizedPostalCode":"string",
            "StandardizedPrivateMailbox":"string",
            "StandardizedResults":"string",
            "StandardizedState":"string",
            "StandardizedStateName":"string",
            "StandardizedSuite":"string",
            "StandardizedUrbanization":"string",
            "State":"string",
            "StateName":"string",
            "Suite":"string",
            "Urbanization":"string"
        }
    ],
    "TotalRecords":"string",
    "TransmissionReference":"string",
    "TransmissionResults":"string",
    "Version":"string"
}