Self-Serve Tariff Code Classification

Version selfservicetarrifclassification
Certificates
Classification
Notes
Profile

ClassificationResponseAttribute

An option/attribute returned for a classification interaction. Each attribute represents a candidate answer (e.g. a material, condition, or ingredient) the caller may select when continuing the classification.

Parameters
idOptional
string

Identifier of this option (UUID). Echo this value as the 'first' field of a values entry in a continue request to select this option.

nameOptional
string

Display name of the option in the response language.

pathOptional
string

Concept hierarchy path of the option, with components separated by '//'. Populated for ITEM-type interactions; null for other interaction types.

valueOptional
string

Selection or weighting state of the option. For VALUED interactions, this is the percentage assigned to the option as a numeric string ("0" when no percentage was set). For SELECTION and other interaction types, this is the literal string of the option, e.g. "knitted"

numberOptional
number

Numeric form of 'value', provided as a convenience for VALUED (mixed-content) interactions so clients do not need to parse the string. When populated, equals Double.valueOf(value). Null for non-VALUED interactions, and also null when 'value' is non-numeric.

kindOfOptional
string

Optional generalization category ("kind of") for the option, such as a material family or product class. May be empty.

defOptional
string

Definition or descriptive gloss of the option when available. May be empty.

frequencyOptional
number

Frequency count from the underlying ontology, indicating how often this option occurs for products of this type.

partOptional
boolean