A Nova Marketing Group service
nCodeCloud
Sign in
Docsmenu

Parameters

Methods for reading and defining the address layouts, analysis modes, and correction styles available to your license key. Use these to discover what's already configured before calling OneStopAnalyze or the Analyze methods.

Customers can read their own parameters plus the shared ones Nova maintains; only your own parameters can be modified or removed.

Retrieval#

GetParamList · GetParamListEx#

http
POST /GetParamList
POST /GetParamListEx

Returns the currently available list of address layouts, analysis modes, or correction styles. The Ex variant adds metadata (creator, last-modified, system vs. user-defined).

bash
curl $NCODE_BASE/GetParamList \
-H "Authorization: AcmeLogistics|nck_live_…" \
-H "Content-Type: application/json" \
-d '{ "ParameterTypes": ["NPAR_AddressLayouts", "NPAR_AnalysisModes", "NPAR_CorrectionStyles"] }'

GetLayoutDetails#

http
POST /GetLayoutDetails

Returns the full definition of a named address layout — line names, line lengths, expected element types. Use to render dynamic forms whose fields match the chosen layout.

GetAnalysisMode · GetCorrectionStyle#

http
POST /GetAnalysisMode
POST /GetCorrectionStyle

Return the full definition of an analysis mode (parsing/matching configuration) or a correction style (casing + keyword treatment).

Definition#

Most customers configure parameters with Nova's visual tools (e.g. nCodeWS4 Batch). The methods below offer programmatic equivalents for automation.

SetAddressLayout · SetAnalysisMode · SetCorrectionStyle#

http
POST /SetAddressLayout
POST /SetAnalysisMode
POST /SetCorrectionStyle

Create or update a parameter definition. The payload mirrors the structure returned by the corresponding Get* method. Parameters live under the calling customer's namespace.

RemoveParameter#

http
POST /RemoveParameter

Remove a parameter previously created via Set*. Shared parameters (Nova-maintained) cannot be removed.