Street Route:Result Codes

From Melissa Data Wiki
Revision as of 21:45, 31 July 2018 by Admin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

← Street Route Cloud API

Street Route Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
Batch JSON
Result Codes
Result Code Use
Street Route Result Codes
Sample Code



Result Code Use

Melissa's products use a result code system to indicate data quality; the status and any errors. These result codes are four-character codes (two letters followed by two numbers), delimited by commas. Result code definitions are shared among Melissa products.

Example

An example returned result code string:

SR11

Instead of looking at multiple properties and methods to determine status, you can look at the output of the results parameter.

From this output you can determine that the route was:

Code Short Description Long Description
SR11 Input or Syntax Error An input or syntax error was detected. The distance calculation cannot be performed.


Understanding the Code

To fully understand result codes, you need to know them. Knowing what codes are possible and what they indicate will be key in building an effective application. It is useful to know all the codes, but this does not necessarily mean you will use them all. Just because you have a toolbox, doesn't mean you will also try to use a screwdriver along with a hammer on a nail.