Street Route

Street Route#

Introduction #

Street Route can:

Find the distance and general drive time between two points
Create a ‘Find the Nearest Location’ tool. Using a database of ‘known / owner destinations’, Street Route can be used to compare a starting point location to the database to return all the route distances and drive times to the possible destinations, which can be queried by the user to present the shortest distance or travel time to the end user.
Determine geolocations which our data sources tell us cannot be reached by vehicle travel. This differentiates Street Route from other distance solutions which return ‘As the crow flies’ distances. Examples are geo points to islands, or rural off road residences.

Click here to learn more about the Street Route 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, Street Route will not function.

Initialization #

There are two different constructors that you can utilize when initializing Street Route.

StreetRoute(string license)

Initialize the Cloud API object with a license key

C#
Python

StreetRoute streetRoute = new StreetRoute(MELISSA_LICENSE_KEY);

street_route = StreetRoute(MELISSA_LICENSE_KEY)

StreetRoute()

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

StreetRoute streetRoute = new StreetRoute()

street_route = StreetRoute()

Configuration #

Street Route 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 StreetRoutePostRequest 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

streetRoute.SetValue("StartLatitude", START_LATITUDE);
streetRoute.SetValue("StartLongitude", START_LONGITUDE);
streetRoute.SetValue("EndLatitude", END_LATITUDE);
streetRoute.SetValue("EndLongitude", END_LONGITUDE);

street_route.set_value("start_latitude", START_LATITUDE)
street_route.set_value("start_longitude", START_LONGITUDE)
street_route.set_value("end_latitude", END_LATITUDE)
street_route.set_value("end_longitude", END_LONGITUDE)

Example

C#
Python

streetRoute.SetValue("StartLatitude", "33.637520");
streetRoute.SetValue("StartLongitude", "-117.606920");
streetRoute.SetValue("EndLatitude", "33.649870");
streetRoute.SetValue("EndLongitude", "-117.582960");

street_route.set_value("start_latitude", "33.637520")
street_route.set_value("start_longitude", "-117.606920")
street_route.set_value("end_latitude", "33.649870")
street_route.set_value("end_longitude", "-117.582960")

Method 2: Using Direct Property Access #

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

Format

C#
Python

streetRoute.StartLatitude = START_LATITUDE;
streetRoute.StartLongitude = START_LONGITUDE;
streetRoute.EndLatitude = END_LATITUDE;
streetRoute.EndLongitude = END_LONGITUDE;

street_route.start_latitude(START_LATITUDE)
street_route.start_longitude(START_LONGITUDE)
street_route.end_latitude(END_LATITUDE)
street_route.end_longitude(END_LONGITUDE)

Example

C#
Python

streetRoute.StartLatitude = "33.637520";
streetRoute.StartLongitude = "-117.606920";
streetRoute.EndLatitude = "33.649870";
streetRoute.EndLongitude = "-117.582960";

street_route.start_latitude("33.637520")
street_route.start_longitude("-117.606920")
street_route.end_latitude("33.649870")
street_route.end_longitude("-117.582960")

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

streetRoute.SetStartLatitude(START_LATITUDE);
streetRoute.SetStartLongitude(START_LONGITUDE);
streetRoute.SetEndLatitude(END_LATITUDE);
streetRoute.SetEndLongitude(END_LONGITUDE);

street_route.set_start_latitude(START_LATITUDE)
street_route.set_start_longitude(START_LONGITUDE)
street_route.set_end_latitude(END_LATITUDE)
street_route.set_end_longitude(END_LONGITUDE)

Example

C#
Python

streetRoute.SetStartLongitude("33.637520");
streetRoute.SetStartLongitude("-117.606920");
streetRoute.SetEndLatitude("33.649870");
streetRoute.SetEndLongitude("-117.582960");

street_route.set_start_latitude("33.637520")
street_route.set_start_longitude("-117.606920")
street_route.set_end_latitude("33.649870")
street_route.set_end_longitude("-117.582960")

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 StreetRoutePostRequest 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

streetRoute.SetPostBody(new StreetRoutePostRequest
{
  CustomerID = MELISSA_LICENSE_KEY,
  Records = new List<StreetRouteRecordRequest>
  {
    new StreetRouteRecordRequest
    {
      RecordID = RECORD_ID,
      StartLatitude = START_LATITUDE,
      StartLongitude = START_LONGITUDE,
      EndLatitude = END_LATITUDE,
      EndLongitude = END_LONGITUDE
    },
    new StreetRouteRecordRequest
    {
      RecordID = RECORD_ID,
      StartLatitude = START_LATITUDE,
      StartLongitude = START_LONGITUDE,
      EndLatitude = END_LATITUDE,
      EndLongitude = END_LONGITUDE
    }
  }
});

street_route.set_post_body(StreetRoutePostRequest(
  customer_id = MELISSA_LICENSE_KEY,
  records=[
    StreetRouteRecordRequest(
      record_id = RECORD_ID,
      start_latitude = START_LATITUDE,
      start_longitude = START_LONGITUDE,
      end_latitude = END_LATITUDE,
      end_longitude = END_LONGITUDE
    ),
    StreetRouteRecordRequest(
      record_id = RECORD_ID,
      start_latitude = START_LATITUDE,
      start_longitude = START_LONGITUDE,
      end_latitude = END_LATITUDE,
      end_longitude = END_LONGITUDE
    )
  ]
))

Example

C#
Python

streetRoute.SetPostBody(new StreetRoutePostRequest
{
  CustomerID = MELISSA_LICENSE_KEY,
  Records = new List<StreetRouteRecordRequest>
  {
    new StreetRouteRecordRequest
    {
      RecordID = "1",
      StartLatitude = "33.637520",
      StartLongitude = "-117.606920",
      EndLatitude = "33.649870",
      EndLongitude = "-117.582960"
    },
    new StreetRouteRecordRequest
    {
        RecordID = "2",
        StartLatitude = "33.637520",
        StartLongitude = "-117.606920",
        EndLatitude = "33.6328945",
        EndLongitude = "-117.61098"
    }
  }
});

street_route.set_post_body(StreetRoutePostRequest(
  customer_id = MELISSA_LICENSE_KEY,
  records=[
    StreetRouteRecordRequest(
      record_id = "1",
      start_latitude = "33.637520",
      start_longitude = "-117.606920",
      end_latitude = "33.649870",
      end_longitude = "-117.582960"
    ),
    StreetRouteRecordRequest(
      record_id = "2",
      start_latitude = "33.637520",
      start_longitude =  "-117.606920",
      end_latitude = "33.6328945",
      end_longitude = "-117.61098"
    )
  ]
))

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

streetRoute.SetLicense(MELISSA_LICENSE_KEY);

streetRoute.AddRecord(new StreetRouteRecordRequest
{
    RecordID = RECORD_ID,
    StartLatitude = START_LATITUDE,
    StartLongitude = START_LONGITUDE,
    EndLatitude = END_LATITUDE,
    EndLongitude = END_LONGITUDE
});

streetRoute.AddRecord(new StreetRouteRecordRequest
{
    RecordID = RECORD_ID,
    StartLatitude = START_LATITUDE,
    StartLongitude = START_LONGITUDE,
    EndLatitude = END_LATITUDE,
    EndLongitude = END_LONGITUDE
});

street_route = StreetRoute(license_key)

street_route.add_record(StreetRouteRecordRequest(
  record_id = RECORD_ID,
  start_latitude = START_LATITUDE,
  start_longitude = START_LONGITUDE,
  end_latitude = END_LATITUDE,
  end_longitude = END_LONGITUDE
))

street_route.add_record(StreetRouteRecordRequest(
  record_id = RECORD_ID,
  start_latitude = START_LATITUDE,
  start_longitude = START_LONGITUDE,
  end_latitude = END_LATITUDE,
  end_longitude = END_LONGITUDE
))

Example

C#
Python

streetRoute.SetLicense(MELISSA_LICENSE_KEY);

streetRoute.AddRecord(new StreetRouteRecordRequest
{
  RecordID = "1",
  StartLatitude = "33.637520",
  StartLongitude = "-117.606920",
  EndLatitude = "33.649870",
  EndLongitude = "-117.582960"
});

streetRoute.AddRecord(new StreetRouteRecordRequest
{
  RecordID = "2",
  StartLatitude = "33.637520",
  StartLongitude = "-117.606920",
  EndLatitude = "33.6328945",
  EndLongitude = "-117.61098"
});

street_route = StreetRoute(license_key)

street_route.add_record(StreetRouteRecordRequest(
  record_id = "1",
  start_latitude = "33.637520",
  start_longitude = "-117.606920",
  end_latitude = "33.649870",
  end_longitude = "-117.582960"
))

street_route.add_record(StreetRouteRecordRequest(
  record_id = "2",
  start_latitude = "33.637520",
  start_longitude = "-117.606920",
  end_latitude = "33.6328945",
  end_longitude = "-117.61098"
))

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 = streetRoute.Get<string>();

response = street_route.get(str)

C#
Python

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

response = street_route.post(str)

As a Response Object #

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

C#
Python

StreetRouteResponse responseObject = streetRoute.Get<StreetRouteResponse>();

response = street_route.get(StreetRouteResponse)

C#
Python

StreetRouteResponse responseObject = streetRoute.Post<StreetRouteResponse>();

response = street_route.post(StreetRouteResponse)

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 Street Route 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 Street Route 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
`StreetRoute()`	Constructor to initialize the Street Route object.
`StreetRoute(string license)`	Constructor to initialize the Street Route object with a license string.

Method	Description
`StreetRoute()`	Constructor to initialize the Street Route object.
`StreetRoute(license)`	Constructor to initialize the Street Route 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 SetUnits(string units)`	Set the units.
`void SetStartLatitude(string startLatitude)`	Set the start latitude.
`void SetStartLongitude(string startLongitude)`	Set the start longitude.
`void SetEndLatitude(string endLatitude)`	Set the end latitude.
`void SetEndLongitude(string endLongitude)`	Set the end longitude.
`void SetTransmissionReference(string transmissionReference)`	Set the transmission reference.
`void SetValue(string parameter, string value)`	Set the input parameter to a specified value.
`void SetPostBody(GlobalPhoneBatchRequest 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_units(units)`	Set the units.
`set_start_latitude(start_latitude)`	Set the start latitude.
`set_start_longitude(start_longitude)`	Set the start longitude.
`set_end_latitude(end_latitude)`	Set the end latitude.
`set_end_longitude(end_longitude)`	Set the end longitude.
`set_transmission_reference(transmission_reference)`	Set the transmission reference.
`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 GetUnits()`	Get the units.
`string GetStartLat()`	Get the start latitude.
`string GetStartLong()`	Get the start longitude.
`string GetEndLat()`	Get the end latitude.
`string GetEndLong()`	Get the end longitude.
`string GetTransmissionReference()`	Get the transmission reference.
`void GetValue(string parameter)`	Get the value of an input parameter.
`StreetRouteBatchRequest 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_units()`	Get the units.
`get_start_lat()`	Get the start latitude.
`get_start_long()`	Get the start longitude.
`get_end_lat()`	Get the end latitude.
`get_end_long()`	Get the end longitude.
`get_transmission_reference()`	Get the transmission reference.
`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(StreetRouteRecordRequest 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 a 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 an asynchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`string GetApiVersion()`	Makes a synchronous getversion request and returns the parsed Cloud API version.
`async Task<string> GetApiVersionAsync()`	Makes an asynchronous getversion request and returns the 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 a synchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`post_async(response_type)`	Makes an asynchronous POST request to the CloudAPI using the post body and returns the response (string or deserialized response object).
`get_api_version()`	Makes a synchronous getversion request and returns the parsed Cloud API version.
`get_api_version_async()`	Makes an asynchronous getversion request and returns the parsed Cloud API version.

Street Route

Contents

Street Route#

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 #