Quote response data dictionary | Allianz Partner Services

Element	Type	Definition
`cxid`	string	Customer Experience ID. This value is returned by AWP in the first quote response so only applies in customer scenarios where the partner is making multiple quote requests within the customer’s browsing session.
`responseID`	string	AWP ID for the response generated as a result of the client optimizations request
`treatmentId`	string	AWP ID of the treatment
`treecode`	string	Selected tree code
`segmentcode`	string	Selected segment code
`Status`	object	System generated response status object
`code`	string	Success indicator
`creationDate`	string	Date/time stamp when the response is generated
`errorText`	string	Specific error description
`machineName`	string	The name of the machine where the service is running (If configured)
`message`	string	Status message
`processId`	integer	Process id of the service
`reason`	string	Textual description of failure
`version`	string	Version of the service
`ProductSequence`	object	Values in array must be listed in same order as associated example customer)
`sequence1`	integer	First value listed in list of sequence names
`sequence2`	integer	Second value listed in list of sequence names
`sequence3`	integer	Third value listed in list of sequence names
`ProductSpecificMessage`	object
`text`	string	Textual content of product specific message.
`type`	string	Type of product specific message.
`uri`	string	Link to product specific message.
`Sequence`	object
`name`	string	Describes/names the ordering (i.e. customer segment leg)
`value`	integer	Value for the ordering (i.e. 1234)
`Option`	object
`name`	string	Option name
`value`	string	Option value
`PriceData`	object	A single price for a product
`isAvailable`	boolean	Indicator flag if price is available
`isIncluded`	boolean	Indicator flag if product/price is included in another product
`options`	array	Array of options specifying this price
`price`	number	Value of price (in currency specified in request)
`priceHash`	string	SHA-256 salted hashed value of price - for validation purposes
`sequences`	array	Price sequence array - used when prices are ordered in certain ways
`stepName`	string	Name of step in Pricing Model
`stepType`	string	Type of step in Pricing Model
`IndividualPrice`	object	Price for an individual/person
`adminFee`	number	Administrative Fee
`personType`	string	Type of person (adult child etc.)
`price`	number	Price
`sequence`	integer	Number in sequence for a given person
`Product`	object	A single product with prices
`externalCode`	string	The product code that the partner uses
`individualPrices`	array	Array of prices per individual
`isAvailable`	boolean	Indicator flag if product is available
`offerId`	string	Internal AWP ID of an offer
`prices`	array	Array of prices for product
`pricingModelCode`	string	AWP Pricing Model Code / Ignored by partner - for debugging purposes only
`pricingModelDescription`	string	General description of the pricing strategy e.g. Flat Percentage Banded
`pricingModelMaxAmount`	number	If defined the maximum price allowed for this product
`pricingModelMinAmount`	number	If defined the minimum price allowed for this product
`productCode`	string	AWP code of the Product-usually based on partner product code
`productDescription`	string	AWP short description of the product
`productHtmlContent`	string	HTML content of the product
`productName`	string	Name of product
`productSpecificMessages`	array
`productType`	string	AWP defined type of product (Seats Insurance Checked Baggage etc.)
`quoteId`	string	Internal AWP ID of a quote
`sequenceNames`	string	Semicolon-delimited list of descriptions/names for the ordering in array of ProductSequence below (i.e. customer segment leg).
`sequences`	array
`supplierCode`	string	AWP defined ID for the supplier
`totalAdminFee`	number	Sum of individual Adminstration fees
`totalPrice`	number	Sum of individual prices
`totalPriceHash`	string	Hash for totalPrice listed above
`totalTax`	number	Sum of individual Taxes
`Trigger`	object	A single trigger that defines an event listener that will cause the changeset to execute
`event`	string	JavaScript event type that needs to occur within selection
`selector`	string	CSS selector that defines the DOM elements to listen to
`type`	string	Type of trigger to be used. The only currently supported value is Event
`Instruction`	object	A single instruction in a changeset
`action`	string	The type of action to be performed
`attributeName`	string	HTML content being inserted at a given position relative to each target element.
`attributeValue`	string	Value of attribute to set on each target element
`booleanValue`	boolean	A boolean value used for setting certain properties like checked
`class`	string	Class value being added to or removed from class list of each target element
`content`	string	HTML content being inserted at a given position relative to each target element.
`element`	string	Element being inserted at a given position relative to target element.
`event`	string	event that is dispatched to each target element
`numericValue`	string	A numeric values used for setting certain properties like selected index
`position`	string	Position relative to the target element
`script`	string	JavaScript code to be run for each target element.
`selector`	string	CSS selector that determines DOM elements on which instructions will be applied
`value`	string	HTML content being inserted at a given position relative to each target element; used for setValue instruction
`ChangeSet`	object	A single changeset
`conditions`	array
`items`	object
`attributeName`	string	Name of attribute on target element(s)
`attributeValue`	string	Value to be compared against the value(s) of target attributes on target element(s)
`booleanValue`	boolean	A boolean value used for evaluating certain properties like checked
`class`	string	Class value to search for in class list of target elements(s)
`compare`	string	How to compare
`matchCase`	boolean	If true use case sensitive comparison
`maximumCount`	number	Desired maximum number of target elements cause the changeset to execute
`minimumCount`	number	Desired minimum number of target elements
`name`	string	Describes/names the condition.
`numericValue`	string	A numeric values used for setting certain properties like selected index
`operator`	string	Used when the condition type is Operator. Indicates the boolean operator that should be applied to the previous condition(s). Allowed values are AND OR and NOT
`selector`	string	CSS selector that defines DOM elements the condition applies to
`type`	string	The type of condition to be checked - see ValidationArray valid values
`value`	string	Value to be compared against the target element(s); used for InnerHTNL OuterHTML TextContent and Value condition types
`instructions`	array	Array of instructions to be executed
`name`	string	The name of the changeset
`selector`	string	CSS selector that specifies DOM element(s) used to narrow scope of triggers conditions and instructions
`triggers`	array	An array of triggers that cause this changeset to execute. Any of the triggers will cause the changeset to execute. If empty the changet will execute right away
`Variation`	object	A single variation to be applied to the DOM
`changesets`	array	Array of changesets that constitute the variation
`responseOfferId`	string	Id of AWP response offer
`validations`	array	Conditions to pass in regard to the state of the DOM before the variation is permited to execute
`variationCode`	string	Internal AWP Code identifying the variation
`Tracking`	object
`conditions`	array	Conditions that must be satisifed before instruction can be executed.
`eventData`	string	Event to be tracked
`selector`	string	CSS selector that specifies DOM elements to listen to
`StatusData`	object
`code`	string	Status code of the response
`errorText`	string	Detailed description of error
`message`	string	Detailed message - if not error
`reason`	string	Reason for status code
`Offer`	object	Content offer
`contentCode`	string	AWP defined code for content offer
`contentType`	string	Type of content offer (ex. Template Offer …)
`id`	string	AWP ID of content offer
`messages`	array	List of messages
`sequence`	integer	Sequence of content offer within array of offers
`Location`	object	A single location
`autoRender`	boolean	Indicator flag if content rendering is applied right away. Applicable only for Variations
`locationCode`	string	AWP defined Code identifying the Location
`locationType`	string	Type of Location
`offers`	array	Array of content offers for this location
`output`	string	In case of HTML locationType this property contains the HTML for the Location
`outputType`	string	Describes the format type of the output(HTML JSON XML Message Component …)
`selector`	string	CSS selector that defines the starting point of the location. If more than one element matches the selector the first element will be used
`templateCode`	string	Template code (need better description)
`templateType`	string	User/Implementation type of the template.
`trackings`	array
`treatmentCode`	string	Selected treatment code
`variations`	array	Array of variations to apply to the DOM
`Cookie`	object	Representation of a single cookie. The Name of the cookie will be generated by prefixing the name of the cookie with FOS<<DISTRIBUTOR_CODE>>_. The Value of the cookie is the whole JSON of this object
`content`	string	Content to be stored in browser Cookie. The actual value depends on the type of Cookie.
`expirationDate`	string	The date that the cookie should expire. With the current implementation this will be the projected end date of the experiment plus a fixed buffer of 7 days. If there is no end date then this will be calculated by adding noOfDays to the current date/time. This is a string formatted as yyyy-mm- ddThh:mi:ss:ffffff
`includeInRequest`	boolean	Indicator if cookie should be included in the request- default to true
`name`	string	Name of the cookie without the namespace prefix
`noOfDays`	integer	Lifetime of the cookie in days
`type`	string	The type the cookie (experiment transactionDetails sessionDetails…)
`OfferStateStructure`	object	Structure of the offer state
`isInternal`	boolean	Indicator to notify if it is internal or external
`isUniqueIdentifier`	boolean	Indicator to notify if it is unique
`rank`	number	Order of the items the cookie is the whole JSON of this object
`sourceName`	string	Name of the source
`sourceType`	string	Type of the source
`targetDefaultValue`	string	Default value of the target
`targetName`	string	Name of the target
`targetParentName`	string	Name of the target’s parent
`targetType`	string	Type of the target
`MessageComponent`	object	Message component
`imageURL`	string	URL of the image
`sequence`	integer	Number defining the sequence of the message component
`style`	string	Style
`text`	string	Text of the message component
`Message`	object	Offer message
`compiledMessage`	string	Content and meaning depends on messageTag.
`messageComponents`	array	Array of message components
`messageTag`	string	Message tag Application defined list of tags (BODY DISCLAIMER CALL_TO_ACTION …)
`cookies`	array	Array of cookies passed from the AWP backend to the client
`locations`	array	Array of locations which are affected by response
`products`	array	Array of products with prices
`offerStateStructure`	array	Structure for offer states. Used by Widget solution where applicable.