SmartMover V3:JSON: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 7: Line 7:


==JSON Request==
==JSON Request==
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 12: Line 13:
     "CustomerID":"string",
     "CustomerID":"string",
     "JobID":"string",
     "JobID":"string",
     "PAFID":"string",
     "PAFId":"string",
     "ExecutionID":"string",
     "ExecutionID":"string",
     "Actions":"string",
     "Actions":"string",

Latest revision as of 23:37, 23 April 2019

← 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



JSON 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",
    "JobID":"string",
    "PAFId":"string",
    "ExecutionID":"string",
    "Actions":"string",
    "Columns":"string",
    "Options":"string",
    "OptSmartMoverListName":"string",
    "Format":"string",
    "Records":[{
        "RecordID":"string",
        "Company":"string",
        "NameFull":"string",
        "NameFirst":"string",
        "NameMiddle":"string",
        "NamePrefix":"string",
        "NameSuffix":"string",
        "NameLast":"string",
        "Urbanization":"string",
        "AddressLine1":"string",
        "AddressLine2":"string",
        "Suite":"string",
        "PrivateMailbox":"string",
        "City":"string",
        "State":"string",
        "PostalCode":"string",
        "Plus4":"string",
        "Country":"string"
    }]
}


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"
}