Smart Mover

Smart Mover#

Introduction #

Smart Mover can:

Keep contact addresses from the US and Canada up to date.
Standardize and validate addresses

Click here to learn more about the Smart Mover Cloud API.

The License Key is a software key required to use the web service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team at Sales@Melissa.com or 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key, Smart Mover will not function.

Initialization #

There are two different constructors that you can utilize when initializing Smart Mover.

SmartMover(string license)

Initialize the Cloud API object with a license key

C#
Python

SmartMover smartMover = new SmartMover(MELISSA_LICENSE_KEY);

smart_mover = SmartMover(MELISSA_LICENSE_KEY)

SmartMover()

Initialize the Cloud API object, which will read the license key from the environment variable MD_LICENSE or configured using a set method

Click here to learn more about setting up the environment variable.

C#
Python

SmartMover smartMover = new SmartMover()

smart_mover = SmartMover()

Configuration #

Smart Mover supports both GET and POST requests.

(GET) Using one of three ways to configure each respective parameter
(POST) Using the Set Post Body Method to pass a SmartMoverPostRequest object as the pre-constructed post body containing all parameters and records to process
(POST) Using Set Methods to configure base parameters and the Add Records Method to pass records to process

Requests #

GET #

To send a GET request, there are three ways you can configure the parameters to make a request.

Method 1: Using the Set Value Method to specify the parameter and value you want to set it to
Method 2: Using direct property access to set parameter values
Method 3: Using specialized Set Methods to set parameter values

Method 1: Using Set Value Method #

This function allows you to specify input parameters and the values you went to set them to.

Format

C#
Python

smartMover.SetValue("PafId", PAF_ID);
smartMover.SetValue("Company", COMPANY);
smartMover.SetValue("FullName", FULL_NAME);
smartMover.SetValue("AddressLine1", ADDRESS_LINE_1);
smartMover.SetValue("City", CITY);
smartMover.SetValue("State", STATE);
smartMover.SetValue("Postal", POSTAL_CODE);
smartMover.SetValue("Country", COUNTRY);

smart_mover.set_value("paf_id", PAF_ID)
smart_mover.set_value("company", COMPANY)
smart_mover.set_value("full_ame", FULL_NAME)
smart_mover.set_value("address_line_1", ADDRESS_LINE_1)
smart_mover.set_value("city", CITY)
smart_mover.set_value("state", STATE)
smart_mover.set_value("postal", POSTAL_CODE)
smart_mover.set_value("country", COUNTRY)

Example

C#
Python

smartMover.SetValue("PafId", PAF_ID);
smartMover.SetValue("Company", "Melissa");
smartMover.SetValue("FullName", "Raymond Melissa");
smartMover.SetValue("AddressLine1", "22382 Avenida Empresa");
smartMover.SetValue("City", "Rancho Santa Margarita");
smartMover.SetValue("State", "CA");
smartMover.SetValue("Postal", "92688");
smartMover.SetValue("Country", "US");

smart_mover.set_value("paf_id", PAF_ID)
smart_mover.set_value("company", "Melissa")
smart_mover.set_value("full_ame", "Raymond Melissa")
smart_mover.set_value("address_line_1", "22382 Avenida Empresa")
smart_mover.set_value("city", "Rancho Santa Margarita")
smart_mover.set_value("state", "CA")
smart_mover.set_value("postal", "92688")
smart_mover.set_value("country", "US")

Method 2: Using Direct Property Access #

This allows you to set values directly using the Cloud API’s parameter names.

Format

C#
Python

smartMover.PafId = PAF_ID;
smartMover.Company = COMPANY;
smartMover.FullName = FULL_NAME;
smartMover.AddressLine1 = ADDRESS_LINE_1;
smartMover.City = CITY;
smartMover.State = STATE;
smartMover.Postal = POSTAL_CODE;
smartMover.Country = COUNTRY;

smart_mover.paf_d = PAF_ID
smart_mover.company = COMPANY
smart_mover.full_name = FULL_NAME
smart_mover.address_line_1 = ADDRESS_LINE_1
smart_mover.city = CITY
smart_mover.state = STATE
smart_mover.postal = POSTAL_CODE
smart_mover.country = COUNTRY

Example

C#
Python

smartMover.PafId = PAF_ID;
smartMover.Company = "Melissa";
smartMover.FullName = "Raymond Melissa";
smartMover.AddressLine1 = "22382 Avenida Empresa";
smartMover.City = "Rancho Santa Margarita";
smartMover.State = "CA";
smartMover.Postal = "92688";
smartMover.Country = "US";

smart_mover.paf_id = PAF_ID
smart_mover.company = "Melissa"
smart_mover.full_name =  "Raymond Melissa"
smart_mover.address_line_1 = "22382 Avenida Empresa"
smart_mover.city = "Rancho Santa Margarita"
smart_mover.state = "CA"
smart_mover.postal = "92688"
smart_mover.country = "US"

Method 3: Using Specialized Methods #

These functions allow you to set the input parameters for the Cloud API.

See Set Methods for a list of available parameters.

Format

C#
Python

smartMover.SetPafID(PAF_ID);
smartMover.SetCompany(COMPANY);
smartMover.SetFullName(FULL_NAME);
smartMover.SetAddressLine1(ADDRESS_LINE_1);
smartMover.SetCity(CITY);
smartMover.SetState(STATE);
smartMover.SetPostal(POSTAL_CODE);
smartMover.SetCountry(COUNTRY);

smart_mover.set_paf_id(PAF_ID)
smart_mover.set_company(COMPANY)
smart_mover.set_full_name(FULL_NAME)
smart_mover.set_address_line_1(ADDRESS_LINE1)
smart_mover.set_city(CITY)
smart_mover.set_state(STATE)
smart_mover.set_postal(POSTAL_CODE)
smart_mover.set_country(COUNTRY)

Example

C#
Python

smartMover.SetPafID(PAF_ID);
smartMover.SetCompany("Melissa");
smartMover.SetFullName("Raymond Melissa");
smartMover.SetAddressLine1("22382 Avenida Empresa");
smartMover.SetCity("Rancho Santa Margarita");
smartMover.SetState("CA");
smartMover.SetPostal("92688");
smartMover.SetCountry("US");

smart_mover.set_paf_id(PAF_ID)
smart_mover.set_company("Melissa")
smart_mover.set_full_name("Raymond Melissa")
smart_mover.set_address_line_1("22382 Avenida Empresa")
smart_mover.set_city("Rancho Santa Margarita")
smart_mover.set_state("CA")
smart_mover.set_postal("92688")
smart_mover.set_country("US")

POST #

To send a POST request, there are two ways you can configure the parameters to make a request.

Method 1: Using the Set Post Body Method to pass a SmartMoverPostRequest object as the pre-constructed post body containing all parameters and records to process
Method 2: Using Set Methods to configure base parameters and the Add Records Method to pass records to process

A maximum of 100 records can be sent per request.

Method 1: Set Post Body #

This function allows you to pass a pre-constructed post body with all parameters and records for POST requests.

Format

C#
Python

smartMover.SetPostBody(new SmartMoverPostRequest
{
    CustomerID = MELISSA_LICENSE_KEY,
    PAFId = PAF_ID,
    Records = new List<SmartMoverRecordRequest>
    {
      new SmartMoverRecordRequest
      {
        RecordID = RECORD_ID,
        Company = COMPANY,
        NameFull = FULL_NAME,
        AddressLine1 = ADDRESS_LINE1,
        City = CITY,
        State = STATE,
        PostalCode = POSTAL_CODE,
        Country = COUNTRY
      },
      new SmartMoverRecordRequest
      {
        RecordID = RECORD_ID,
        Company = COMPANY,
        NameFull = FULL_NAME,
        AddressLine1 = ADDRESS_LINE1,
        City = CITY,
        State = STATE,
        PostalCode = POSTAL_CODE,
        Country = COUNTRY
      }
    }
});

smart_mover.set_post_body( SmartMoverPostRequest(
  customer_id=license_key,
  paf_id=paf_id,
  records=[
    SmartMoverRecordRequest
    (
      record_id = RECORD_ID,
      company = COMPANY,
      name_full = FULL_NAME,
      address_line_1 = ADDRESS_LINE1,
      city = CITY,
      state = STATE,
      postal_code = POSTAL_CODE,
      country = COUNTRY
    ),
    SmartMoverRecordRequest
    (
      record_id = RECORD_ID,
      company = COMPANY,
      name_full = FULL_NAME,
      address_line_1 = ADDRESS_LINE1,
      city = CITY,
      state = STATE,
      postal_code = POSTAL_CODE,
      country = COUNTRY
    )
  ]
))

Example

C#
Python

smartMover.SetPostBody(new SmartMoverPostRequest
{
    CustomerID = MELISSA_LICENSE_KEY,
    PAFId = PAF_ID,
    Records = new List<SmartMoverRecordRequest>
    {
      new SmartMoverRecordRequest
      {
        RecordID = "1",
        Company = "Melissa",
        NameFull = "Raymond Melissa",
        AddressLine1 = "22382 Avenida Empresa",
        City = "Rancho Santa Margarita",
        State = "CA",
        PostalCode = "92688",
        Country = "US"
      },
      new SmartMoverRecordRequest
      {
        RecordID = "2",
        Company = "Microsoft",
        NameFull = "Bill Gates",
        AddressLine1 = "1 Microsoft Way",
        City = "Redmond",
        State = "WA",
        PostalCode = "98052",
        Country = "US"
      }
    }
});

smart_mover.set_post_body( SmartMoverPostRequest(
  customer_id=license_key,
  paf_id=paf_id,
  records=[
    SmartMoverRecordRequest
    (
      record_id = "1",
      company = "Melissa",
      name_full = "Raymond Melissa",
      address_line_1 = "22382 Avenida Empresa",
      city = "Rancho Santa Margarita",
      state = "CA",
      postal_code = "92688",
      country = "US"
    ),
    SmartMoverRecordRequest
    (
      record_id = "2",
      company = "Microsoft",
      name_full = "Bill Gates",
      address_line_1 = "1 Microsoft Way",
      city = "Redmond",
      state = "WA",
      postal_code = "98052",
      country = "US"
    )
  ]
))

Method 2: Set Input Parameters and Add Records #

You will use set methods to configure the base parameters (license, options, transmission reference), and use the function below to add records for POST requests.

See Set Methods for a list of available parameters.

Format

C#
Python

smartMover.SetLicense(MELISSA_LICENSE_KEY);
smartMover.SetPafID(PAF_ID);

smartMover.AddRecord(new SmartMoverRecordRequest
{
  RecordID = RECORD_ID,
  Company = COMPANY,
  NameFull = FULL_NAME,
  AddressLine1 = ADDRESS_LINE_1,
  City = CITY,
  State = STATE,
  PostalCode = POSTAL_CODE,
  Country = COUNTRY
});

smartMover.AddRecord(new SmartMoverRecordRequest
{
  RecordID = RECORD_ID,
  Company = COMPANY,
  NameFull = FULL_NAME,
  AddressLine1 = ADDRESS_LINE_1,
  City = CITY,
  State = STATE,
  PostalCode = POSTAL_CODE,
  Country = COUNTRY
});

smart_mover = SmartMover(license_key)
smart_mover.set_paf_id(paf_id)

smart_mover.add_record(SmartMoverRecordRequest(
    record_id = RECORD_ID,
    company = COMPANY,
    name_full = FULL_NAME,
    address_line_1 = ADDRESS_LINE_1,
    city = CITY,
    state = STATE,
    postal_code = POSTAL_CODE,
    country = COUNTRY
  )
)

smart_mover.add_record(SmartMoverRecordRequest(
    record_id = RECORD_ID,
    company = COMPANY,
    name_full = FULL_NAME,
    address_line_1 = ADDRESS_LINE_1,
    city = CITY,
    state = STATE,
    postal_code = POSTAL_CODE,
    country = COUNTRY
  )
)

Example

C#
Python

smartMover.SetLicense(MELISSA_LICENSE_KEY);
smartMover.SetPafID(PAF_ID);

smartMover.AddRecord(new SmartMoverRecordRequest
{
  RecordID = "1",
  Company = "Melissa",
  NameFull = "Ray Melissa",
  AddressLine1 = "22382 Avenida Empresa",
  City = "Rancho Santa Margarita",
  State = "CA",
  PostalCode = "92688",
  Country = "US"
});

smartMover.AddRecord(new SmartMoverRecordRequest
{
  RecordID = "2",
  Company = "Microsoft",
  NameFull = "Bill Gates",
  AddressLine1 = "1 Microsoft Way",
  City = "Redmond",
  State = "WA",
  PostalCode = "98052",
  Country = "US"
});

smart_mover = SmartMover(license_key)
smart_mover.set_paf_id(paf_id)

smart_mover.add_record(SmartMoverRecordRequest(
    record_id = "1",
    company = "Melissa",
    name_full = "Ray Melissa",
    address_line_1 = "22382 Avenida Empresa",
    city = "Rancho Santa Margarita",
    state = "CA",
    postal_code = "92688",
    country = "US"
  )
)

smart_mover.add_record(SmartMoverRecordRequest(
    record_id = "2",
    company = "Microsoft",
    name_full = "Bill Gates",
    address_line_1 = "1 Microsoft Way",
    city = "Redmond",
    state = "WA",
    postal_code = "98052",
    country = "US"
  )
)

Response #

When submitting a request, you have the option to either get the response as a string or encapsulate the response into the respective Cloud API response object.

As a String #

Submit a GET or POST request and get the response as a string.

C#
Python

string response = smartMover.Get<string>();

response = smart_mover.get(str)

C#
Python

string response = smartMover.Post<string>();

response = smart_mover.post(str)

As a Response Object #

Submit a GET or POST request and encapsulate the response into the Cloud API response object.

C#
Python

SmartMoverResponse responseObject = smartMover.Get<SmartMoverResponse>();

response = smart_mover.get(SmartMoverResponse)

C#
Python

SmartMoverResponse responseObject = smartMover.Post<SmartMoverResponse>();

response = smart_mover.post(SmartMoverResponse)

Accessing Values #

When encapsulating the response into the Cloud API’s respective response object, there are three ways to access values. The response object structure matches the respective Cloud API’s response format.

Click here to learn more about the Smart Mover response format.

The record responses are typically stored in a list. In the examples below, record represents an individual record at an arbitrary position within this list.

1. Using the Get Value Method:

Pass the field name as a string to the Get Value Method, and it will return the corresponding field value.

C#
Python

record.GetValue("RecordID");
record.GetValue("Results");

record.get_value("RecordID")
record.get_value("Results")

2. Accessing Properties directly

Values can be accessed directly using the response object’s field names.

C#
Python

record.RecordID;
record.Results;

record.record_id
record.results

3. Use Specialized Methods

Use get methods corresponding to field name to get the field value.

C#
Python

record.GetRecordID();
record.GetResults();

record.get_record_id()
record.get_results()

Methods #

The methods listed below pertain to the Smart Mover Cloud API object.

For methods related to the respective Cloud API’s response object click here.

Constructors #

These methods initialize and configure instances of the Cloud API object. Use these methods to create a new object, optionally providing initial values such as a license string to customize the instance during its creation.

C#
Python

Method	Description
`SmartMover()`	Constructor to initialize the Smart Mover object.
`SmartMover(string license)`	Constructor to initialize the Smart Mover object with a license string.

Method	Description
`SmartMover()`	Constructor to initialize the Smart Mover object.
`SmartMover(license)`	Constructor to initialize the Smart Mover object with a license string.

Set Methods #

These methods configure or modify parameters at the record level for the Cloud API object. Use these methods to make adjustments to the parameters during the execution of the Cloud API, ensuring flexibility in customizing API requests.

C#
Python

Method	Description
`void SetBaseUrl(string baseUrl)`	Set the base URL.
`void SetLicense(string license)`	Set the license string.
`void SetEndpoint(string endpoint)`	Set the endpoint.
`void SetFormat(string format)`	Set the format.
`void SetJobID(string jobID)`	Set the job ID.
`void SetPafID(string pafID)`	Set the paf ID.
`void SetAction(string action)`	Set the action.
`void SetList(string list)`	Set the list.
`void SetCompany(string company)`	Set the company.
`void SetFullName(string fullName)`	Set the full name.
`void SetFirstName(string firstName)`	Set the first name.
`void SetMiddleName(string middleName)`	Set the middle name.
`void SetNamePrefix(string namePrefix)`	Set the name prefix.
`void SetNameSuffix(string nameSuffix)`	Set the name suffix.
`void SetLastName(string lastName)`	Set the last name.
`void SetUrbanization(string urbanization)`	Set the urbanization.
`void SetAddressLine1(string addressLine1)`	Set the address line 1.
`void SetAddressLine2(string addressLine2)`	Set the address line 2.
`void SetSuite(string suite)`	Set the suite.
`void SetPrivateMailbox(string privateMailbox)`	Set the private mailbox.
`void SetCity(string city)`	Set the city.
`void SetState(string state)`	Set the state.
`void SetPostal(string postal)`	Set the postal code.
`void SetPlus4(string plus4)`	Set the plus 4.
`void SetCountry(string country)`	Set the country.
`void SetTransmissionReference(string transmissionReference)`	Set the transmission reference.
`void SetOpt(string opt)`	Set the option.
`void SetCols(string cols)`	Set the columns.
`void SetValue(string parameter, string value)`	Set the input parameter to a specified value.
`void SetPostBody(SmartMoverBatchRequest postBody)`	Set the post body for post requests.

Method	Description
`set_base_url(base_url)`	Set the base URL.
`set_license(license)`	Set the license string.
`set_endpoint(endpoint)`	Set the endpoint.
`set_format(format)`	Set the format.
`set_job_id(job_id)`	Set the job ID.
`set_paf_id(paf_id)`	Set the paf ID.
`set_action(action)`	Set the action.
`set_list(list)`	Set the list.
`set_company(company)`	Set the company.
`set_full_name(full_name)`	Set the full name.
`set_first_name(first_name)`	Set the first name.
`set_middle_name(middle_name)`	Set the middle name.
`set_name_prefix(name_prefix)`	Set the name prefix.
`set_name_suffix(name_suffix)`	Set the name suffix.
`set_last_name(last_name)`	Set the last name.
`set_urbanization(urbanization)`	Set the urbanization.
`set_address_line_1(address_line_1)`	Set the address line 1.
`set_address_line2(address_line2)`	Set the address line 2.
`set_suite(suite)`	Set the suite.
`set_private_mailbox(private_mailbox)`	Set the private mailbox.
`set_city(city)`	Set the city.
`set_state(state)`	Set the state.
`set_postal(postal)`	Set the postal code.
`set_plus4(plus4)`	Set the plus 4.
`set_country(country)`	Set the country.
`set_transmission_reference(transmission_reference)`	Set the transmission reference.
`set_opt(opt)`	Set the option.
`set_cols(cols)`	Set the columns.
`set_value(parameter, value)`	Set the input parameter to a specified value.
`set_post_body(post_body)`	Set the post body for post requests.

Get Methods #

These methods retrieve parameter values from the Cloud API object. Use these methods to access the parameters configured for the Cloud API at the record level, providing insight into the current state of the object’s settings.

C#
Python

Method	Description
`string GetBaseUrl()`	Get the base URL.
`string GetLicense()`	Get the license string.
`string GetEndpoint()`	Get the endpoint.
`string GetFormat()`	Get the format.
`string GetJobID()`	Get the job ID.
`string GetPafID()`	Get the paf ID.
`string GetAction()`	Get the action.
`string GetList()`	Get the list.
`string GetCompany()`	Get the company.
`string GetFullName()`	Get the full name.
`string GetFirstName()`	Get the first name.
`string GetMiddleName()`	Get the middle name.
`string GetNamePrefix()`	Get the name prefix.
`string GetNameSuffix()`	Get the name suffix.
`string GetLastName()`	Get the last name.
`string GetUrbanization()`	Get the urbanization.
`string GetAddressLine1()`	Get the address line 1.
`string GetAddressLine2()`	Get the address line 2.
`string GetSuite()`	Get the suite.
`string GetPrivateMailbox()`	Get the private mailbox.
`string GetCity()`	Get the city.
`string GetState()`	Get the state.
`string GetPostal()`	Get the postal code.
`string GetPlus4()`	Get the plus 4.
`string GetCountry()`	Get the country.
`string GetTransmissionReference()`	Get the transmission reference.
`string GetOpt()`	Get the option.
`string GetCols()`	Get the columns.
`void GetValue(string parameter)`	Get the value of an input parameter.
`SmartMoverBatchRequest GetPostBody()`	Get the post body for post requests.

Method	Description
`get_base_url()`	Get the base URL.
`get_license()`	Get the license string.
`get_endpoint()`	Get the endpoint.
`get_format()`	Get the format.
`get_job_id()`	Get the job ID.
`get_paf_id()`	Get the paf ID.
`get_action()`	Get the action.
`get_list()`	Get the list.
`get_company()`	Get the company.
`get_full_name()`	Get the full name.
`get_first_name()`	Get the first name.
`get_middle_name()`	Get the middle name.
`get_name_prefix()`	Get the name prefix.
`get_name_suffix()`	Get the name suffix.
`get_last_name()`	Get the last name.
`get_urbanization()`	Get the urbanization.
`get_address_line_1()`	Get the address line 1.
`get_address_line2()`	Get the address line 2.
`get_suite()`	Get the suite.
`get_private_mailbox()`	Get the private mailbox.
`get_city()`	Get the city.
`get_state()`	Get the state.
`get_postal()`	Get the postal code.
`get_plus4()`	Get the plus 4.
`get_country()`	Get the country.
`get_transmission_reference()`	Get the transmission reference.
`get_opt()`	Get the option.
`get_cols()`	Get the columns.
`get_value(parameter)`	Get the value of an input parameter.
`get_post_body()`	Get the post body for post requests.

Class Methods #

These methods perform service-level operations, handling the core processing and interactions for the Cloud API object. Use these methods to execute primary functionalities such as assembling records, clearing records, and making API requests.

C#
Python

Method	Description
`void AddRecord(SmartMoverRecordRequest record)`	Add record to internal list for post body assembly.
`void ClearRecords()`	Clear the internal list of records.
`T Get<T>()`	Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`async Task<T> GetAsync<T>()`	Makes the asynchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`T Post<T>()`	Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`async Task<T> PostAsync<T>()`	Makes asynchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`string GetApiVersion()`	Makes synchronous getversion request and returns parsed Cloud API version.
`async Task<string> GetApiVersionAsync()`	Makes asynchronous getversion request and returns parsed Cloud API version.

Method	Description
`add_record(record)`	Add record to internal list for post body assembly.
`clear_records()`	Clear the internal list of records.
`get(response_type)`	Makes the synchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`get_async(response_type)`	Makes the asynchronous GET request to the CloudAPI and returns the response (string or deserialized response object).
`post(response_type)`	Makes synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`post_async(response_type)`	Makes asynchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`get_api_version()`	Makes synchronous getversion request and returns parsed Cloud API version.
`get_api_version_async()`	Makes asynchronous getversion request and returns parsed Cloud API version.

Smart Mover

Contents

Smart Mover#

Introduction #

Licensing #

Initialization #

Configuration #

Requests #

GET #

Method 1: Using Set Value Method #

Method 2: Using Direct Property Access #

Method 3: Using Specialized Methods #

POST #

Method 1: Set Post Body #

Method 2: Set Input Parameters and Add Records #

Response #

As a String #

As a Response Object #

Accessing Values #

Methods #

Constructors #

Set Methods #

Get Methods #

Class Methods #