Step Details | |
| Introduced in Version | 4.0.0 |
| Last Modified in Version | 7.1.0 |
| Location | Integration > USPS |
The Get Information By Zip step returns the city, zip code, and state of the specified zip code.
Prerequisites
This step requires the USPS module to be installed before it will be available in the toolbox.
Properties
Inputs
| Property | Description | Data Type |
|---|---|---|
| Zip5 | The desired zip code. | String |
Outputs
| Property | Description | Data Type |
|---|---|---|
| Output | Information about the zip code. | CityStateLookupResponse |
Example Inputs and Outputs
| Zip5 | Output |
|---|---|
| 23455 | Zip5:"23455", City:"VIRGINIA BEACH", State:"VA", Error:null |
| 23323 | Zip5:"23323", City:"CHESAPEAKE", State:"VA", Error:null |
| Null | Zip5:null, City:null, State:null, Error: Number: "-2147219399", Source:"WebtoolsAMS;CityStateLookup", Description: "Invalid Zip Code." |
| 9023 | Zip5:null, City:null, State:null, Error:[Number:"-2147219024",Source:"WebtoolsAMS;CityStateLookup",Description:"ZIPCode must be 5 characters"] |
| Empty | EXCEPTION MESSAGE |
Common Errors
Incorrect Parameter Count, Data Not Mapped Correctly
If the zip code is empty, the step will cause an error.
To correct this, ensure that a properly formatted zip code is entered or mapped.
Exception Message:
Exception Stack Trace: DecisionsFramework.Design.Flow.ErrorRunningFlowStep: Error running step Get Information By Zip 1[GetInformationByZip] in flow [Flow 1]: Incorrect Parmater Count, Data Not Mapped Correctly
---> DecisionsFramework.LoggedException: Incorrect Parmater Count, Data Not Mapped Correctly
---> System.Reflection.TargetParameterCountException: Parameter count mismatch. at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture
at DecisionsFramework.Design.Flow.StepImplementations.InvokeMethodStep.Run(StepStartData data)
--- End of inner exception stack trace --- at DecisionsFramework.Design.Flow.StepImplementations.InvokeMethodStep.Run(StepStartData data
at DecisionsFramework.Design.Flow.FlowStep.RunStepInternal(String flowTrackingID, String stepTrackingID, KeyValuePairDataStructure[] stepRunDataValues, AbstractFlowTrackingData trackingData
at DecisionsFramework.Design.Flow.FlowStep.Start(String flowTrackingID, String stepTrackingID, FlowStateData data, AbstractFlowTrackingData trackingData, RunningStepData currentStepData)
--- End of inner exception stack trace ---Related Information
Forum Posts:
USPS Module Example: Get City & State By Zip
USPS Address Verification Service
Get State From Zip