Overview
The purpose of this document is to define the JSON payload for the SurveyResponse webhook from Aimbase.
The SurveyResponse webhook is subscribed to from the Webhook API. Please see the Aimbase Webhook Subscribe Web Service Specification document for information about how to subscribe to the webhook.
The SurveyResponse payload is sent to the PostUrl via HTTP POST. The Content-Type HTTP header will be “application/json”.
It is expected that the PostUrl endpoint will respond to the request with a 200 (Ok) HTTP status code. If any other response is given, it is assumed that the request failed and then it will attempt retries. The request will be retried up to 3 times, after 20 seconds, 20 minutes, and 20 hours. If all retries fail, it will not attempt to send the request again.
Below is the list of properties that are in the POST body.
SurveyResponse Payload Data Schema
Field Name |
Required |
Format |
Description |
Id |
X |
Number |
The SurveyResponse record’s identifier. |
Data |
X |
Key/value pairs |
A collection of key/value pairs of data. This data is included from the Webhook subscription. |
Record |
X |
Record |
A record object that contains information about the survey response’s Owner, Survey, Registration, and Survey Response values. |
Record Data Schema
Field Name |
Required |
Format |
Description |
Id |
X |
Number |
The SurveyResponse record’s identifier. |
SurveyKeyUid |
X |
GUID |
The unique identifier of the SurveyKey. |
SurveyKeyId |
X |
Number |
The identifier of the SurveyKey. |
SurveyDate |
X |
Date |
The date the survey was first sent to the owner. |
ResponseDate |
X |
Date |
The date the owner responded to the survey. |
IsNotReporting |
X |
Boolean |
If the survey response has been marked as to be not included in reporting data. |
SurveyFormName |
X |
|
The name of the survey form. |
SurveyTypeCode |
X |
|
The unique code of the survey’s type. Common values are R0 and F12M. |
SurveyTypeName |
X |
|
The name of the survey’s type. Common values are Initial Quality Survey and Follow-up Survey 12 Month. |
SurveyCategoryCode |
X |
|
The unique code of the survey type’s category. Common values are R and F. |
SurveyCategoryName |
X |
|
The name of the survey type’s category. Common values are Initial Quality Survey and Follow-up Survey. |
DealerSentimentCode |
X |
|
The unique code of the overall sentiment of the dealer in the survey response. Possible values are:
Promoter Passive Detractor Unknown Positive Neutral Negative |
DealerSentimentName |
X |
|
The name of the overall sentiment of the dealer in the survey response. Possible values are:
Promoter Passive Detractor Unknown Positive Neutral Negative |
ManufacturerSentimentCode |
X |
|
The unique code of the overall sentiment of the manufacturer in the survey response. Possible values are:
Promoter Passive Detractor Unknown Positive Neutral Negative |
ManufacturerSentimentName |
X |
|
The name of the overall sentiment of the manufacturer in the survey response. Possible values are:
Promoter Passive Detractor Unknown Positive Neutral Negative |
RegistrationHistoryId |
X |
|
The identifier of the registration record. |
SerialNumber |
X |
|
The serial number of the registered product. |
| ClaimNumber | X | The claim number of the warranty. If no warranty data, this field will return as null. | |
PurchaseDate |
|
|
The date the product was purchased. |
OwnerId |
X |
Number |
The Aimbase owner Id which may be used to reference the owner in other api endpoints in aimbase. |
OwnerFirstName |
|
|
The first name of the owner. |
OwnerLastName |
X |
|
The last name of the owner. |
OwnerAddress1 |
|
|
The mailing address line 1 of the owner. |
OwnerAddress2 |
|
|
The mailing address line 2 of the owner. |
OwnerCity |
|
|
The mailing address city of the owner. |
OwnerState |
|
|
The mailing address state or province of the owner. |
OwnerPostalCode |
|
|
The mailing address postal code of the owner. |
OwnerCountryCode |
|
|
The mailing address country code of the owner. |
OwnerHomePhone |
|
|
The home phone number of the owner. |
OwnerEmail |
|
|
The email address of the owner. |
DealerName |
X |
|
The name of the dealer. |
DealerNumber |
X |
|
The external identifier of the dealer. |
DealerLocation |
|
|
The external identifier of the dealer’s location. |
| DealerContact | The contact setup for the dealer. | ||
| DealerEmail | The email of the dealer. | ||
| DealerEmailCC | The email cc of the dealer. | ||
| DealerWebsiteURL | The website url of the dealer. | ||
| DealerAddress1 | The mailing address line 1 of the dealer. | ||
| DealerAddress2 | The mailing address line 2 of the dealer. | ||
| DealerCity | The mailing address city of the dealer. | ||
| DealerState | The mailing address state of the dealer. | ||
| DealerPostalCode | The mailing address postal code of the dealer. | ||
| DealerCountry | The mailing address country of the dealer. | ||
| DealerCountryCode | The mailing address country code of the dealer. | ||
| DealerPhone | The phone number of the dealer. | ||
| DealerIsActive | Dealer active. | ||
| DealerManufacturerCode | The manufacture code assigned to the dealer. | ||
| DealerTypeCode | The type code of the dealer. Standard, default or custom type. | ||
| DealerGroupCode | The group code for a dealer with multiple locations. | ||
| DealerSalesPersonAssignmentTypeCode | The sales person assignment for that dealer. | ||
| DealerCustoms | Available custom dealer fields | ||
| DealerTerritoryName | The territory the dealer is assigned. | ||
| DealerRegionName | The region the dealer is assigned. | ||
| DealerDistrictName | The district the dealer is assigned. | ||
ProductCode |
X |
|
The unique identifier of the product model. |
ProductName |
X |
|
The name of the product model. |
ProductModelYear |
X |
|
The year of the product model. |
BrandName |
X |
|
The name of the product model’s Brand. |
ProductCategoryName |
|
|
The product’s category name. |
ProductSegmentName |
|
|
The product’s segment or sub-category name. |
ProductPlantName |
|
|
The product’s plant name where the product is manufactured. |
SurveySourceName |
X |
|
The source of the survey response. Common values are One-Click Online Survey, Mailed In Survey, Postcard, or Email Survey. |
SurveyLanguageCode |
X |
|
The two letter ISO 639-1 language code of the survey that was completed. Common values are en, es, fr |
SurveyResponseValues |
X |
SurveyResponseValue |
A collection of SurveyResponseValues that have each individual question response for the overall survey response. |
| Customs | Collection of Custom Data. | The custom data associated with registration. |
SurveyResponseValue Data Schema
Field Name |
Required |
Format |
Description |
DisplayName |
X |
|
The display text of the control on the survey form. |
SurveyFieldName |
|
|
The reporting survey field’s name. This value can be shared across survey forms to aggregate responses to the same question on different forms. |
FieldValue |
|
|
The question’s response text value that was entered or selected by the owner. |
FieldWeight |
|
Number |
The reporting field weight of the question response that was entered or selected by the user. This value can be used to calculate the reported score. |
DisplayOrder |
X |
Number |
The order this control is displayed on the survey form. |
InputTypeName |
X |
|
The name of the type of input of this control on the survey form. |
SurveyQuestionReportingTypeName |
|
|
The reporting type of this question on the survey form. Common values are:
NPS Mean Other POP Feedback |
Number |
|
|
The question number of this question on the survey form. |
Letter |
|
|
The question letter of this question on the survey form. |
APPENDIX A – Sample POST Content (JSON)
{
"Id":1712,
"Data":{
},
"Record":{
"Id":1712,
"Disposition":"Completed",
"IsNotReporting":false,
"DealerSentimentCode":"Unknown",
"DealerSentimentName":"Unknown",
"ManufacturerSentimentCode":"Unknown",
"ManufacturerSentimentName":"Unknown",
"SurveySourceName":"Mailed In Survey",
"SurveyResponseValues":[
{
"DisplayName": "TELL US ABOUT YOUR OVERALL SATISFACTION WITH YOUR NEW PRODUCT, DEALER AND ENGINE",
"SurveyFieldName": "",
"FieldValue": "",
"FieldWeight": null,
"DisplayOrder": 0,
"InputTypeName": "Section Header",
"SurveyQuestionReportingTypeName": null,
"Number": null,
"Letter": null
},
{
"DisplayName": "Six Choice Question Header",
"SurveyFieldName": "",
"FieldValue": "",
"FieldWeight": null,
"DisplayOrder": 1,
"InputTypeName": "Six Choice Question Header",
"SurveyQuestionReportingTypeName": null,
"Number": null,
"Letter": null
},
{
"DisplayName": "Thinking about the product itself, excluding any impact the sales and service experience may have had, please indicate your satisfaction with your new product overall.",
"SurveyFieldName": "Overall Boat",
"FieldValue": "80",
"FieldWeight": 80,
"DisplayOrder": 2,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "1",
"Letter": null
},
{
"DisplayName": "Thinking about your dealer, excluding any impact the product experience may have had, please indicate your satisfaction with your dealer overall.",
"SurveyFieldName": "Overall Dealer",
"FieldValue": "80",
"FieldWeight": 80,
"DisplayOrder": 3,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "2",
"Letter": null
},
{
"DisplayName": "Eleven Choice Question Header",
"SurveyFieldName": "",
"FieldValue": "",
"FieldWeight": null,
"DisplayOrder": 5,
"InputTypeName": "Eleven Choice Question Header",
"SurveyQuestionReportingTypeName": null,
"Number": null,
"Letter": null
},
{
"DisplayName": "Based on your overall experience with your product, how likely are you to recommend your boat to friends or family members?",
"SurveyFieldName": "NPS Recommend Boat",
"FieldValue": "9",
"FieldWeight": 9,
"DisplayOrder": 6,
"InputTypeName": "Eleven Choice Question",
"SurveyQuestionReportingTypeName": "NPS",
"Number": "4",
"Letter": null
},
{
"DisplayName": "Based on your overall experience with your dealer, how likely are you to recommend your dealer to friends or family members?",
"SurveyFieldName": "NPS Recommend Dealer",
"FieldValue": "10",
"FieldWeight": 10,
"DisplayOrder": 7,
"InputTypeName": "Eleven Choice Question",
"SurveyQuestionReportingTypeName": "NPS",
"Number": "5",
"Letter": null
},
{
"DisplayName": "ABOUT YOUR PURCHASE DECISION",
"SurveyFieldName": "",
"FieldValue": "",
"FieldWeight": null,
"DisplayOrder": 8,
"InputTypeName": "Section Header",
"SurveyQuestionReportingTypeName": null,
"Number": null,
"Letter": null
},
{
"DisplayName": "What was the number one reason for choosing your product?",
"SurveyFieldName": "#1 Reason for choice of product",
"FieldValue": "Ride and Performance",
"FieldWeight": null,
"DisplayOrder": 9,
"InputTypeName": "Multiple Choice (Select Many) 2",
"SurveyQuestionReportingTypeName": "POP",
"Number": "6",
"Letter": null
},
{
"DisplayName": "Please describe your purchase decision-making process: (Select all that apply)",
"SurveyFieldName": "Decision Making Process Factors",
"FieldValue": "Previous Brand Owner",
"FieldWeight": null,
"DisplayOrder": 10,
"InputTypeName": "Multiple Choice (Select Many) 2",
"SurveyQuestionReportingTypeName": "POP",
"Number": "7",
"Letter": null
},
{
"DisplayName": "Please describe your purchase decision-making process: (Select all that apply)",
"SurveyFieldName": "Decision Making Process Factors",
"FieldValue": "Website research",
"FieldWeight": null,
"DisplayOrder": 10,
"InputTypeName": "Multiple Choice (Select Many) 2",
"SurveyQuestionReportingTypeName": "POP",
"Number": "7",
"Letter": null
},
{
"DisplayName": "Please describe your purchase decision-making process: (Select all that apply)",
"SurveyFieldName": "Decision Making Process Factors",
"FieldValue": "Dealer visit(s)",
"FieldWeight": null,
"DisplayOrder": 10,
"InputTypeName": "Multiple Choice (Select Many) 2",
"SurveyQuestionReportingTypeName": "POP",
"Number": "7",
"Letter": null
},
{
"DisplayName": "ABOUT YOUR DEALER AND PURCHASE EXPERIENCE",
"SurveyFieldName": "",
"FieldValue": "",
"FieldWeight": null,
"DisplayOrder": 11,
"InputTypeName": "Section Header",
"SurveyQuestionReportingTypeName": null,
"Number": null,
"Letter": null
},
{
"DisplayName": "Based on your buying experience, how satisfied were you with your Dealer in each of the following areas?",
"SurveyFieldName": "",
"FieldValue": "",
"FieldWeight": null,
"DisplayOrder": 12,
"InputTypeName": "Six Choice Question Header",
"SurveyQuestionReportingTypeName": null,
"Number": "8",
"Letter": null
},
{
"DisplayName": "Appearance of dealership ",
"SurveyFieldName": "Dealership Facility Appearance",
"FieldValue": "80",
"FieldWeight": 80,
"DisplayOrder": 13,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "a"
},
{
"DisplayName": "Product knowledge",
"SurveyFieldName": "Sales Manufacturer Product Knowledge",
"FieldValue": "100",
"FieldWeight": 100,
"DisplayOrder": 14,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "b"
},
{
"DisplayName": "Explanation of pricing",
"SurveyFieldName": "Sales Dealer Explanation of pricing",
"FieldValue": "100",
"FieldWeight": 100,
"DisplayOrder": 15,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "c"
},
{
"DisplayName": "Explanation of service and routine maintenance",
"SurveyFieldName": "Dealer Satisfaction Explanation of Maintenance",
"FieldValue": "50",
"FieldWeight": 50,
"DisplayOrder": 16,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "d"
},
{
"DisplayName": "Explanation of warranties",
"SurveyFieldName": "Dealer Satisfaction Warranty Explanation",
"FieldValue": "80",
"FieldWeight": 80,
"DisplayOrder": 17,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "e"
},
{
"DisplayName": "Product ready when promised",
"SurveyFieldName": "Service Dealer Boat Ready",
"FieldValue": "20",
"FieldWeight": 20,
"DisplayOrder": 18,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "f"
},
{
"DisplayName": "Boat condition at delivery",
"SurveyFieldName": "Dealer Satisfaction Boat Condition",
"FieldValue": "100",
"FieldWeight": 100,
"DisplayOrder": 20,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "h"
},
{
"DisplayName": "Demonstration of product, equipment and features",
"SurveyFieldName": "Dealer Satisfaction Demonstration",
"FieldValue": "80",
"FieldWeight": 80,
"DisplayOrder": 21,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "i"
},
{
"DisplayName": "Your overall buying experience with this dealership",
"SurveyFieldName": "Dealership Overall Buying Experience",
"FieldValue": "80",
"FieldWeight": 80,
"DisplayOrder": 22,
"InputTypeName": "Six Choice Question",
"SurveyQuestionReportingTypeName": "Mean",
"Number": "8",
"Letter": "j"
},
{
"DisplayName": "Did you receive an on water demonstration prior to or at the time of taking delivery of your product?",
"SurveyFieldName": "Received On Water Demonstration",
"FieldValue": "No",
"FieldWeight": null,
"DisplayOrder": 23,
"InputTypeName": "Two Option Question",
"SurveyQuestionReportingTypeName": "POP",
"Number": "9",
"Letter": null
},
{
"DisplayName": "Did you receive a follow-up call from the dealership after taking delivery of your product?",
"SurveyFieldName": "Dealership Follow Up Call?",
"FieldValue": "Yes",
"FieldWeight": null,
"DisplayOrder": 24,
"InputTypeName": "Two Option Question",
"SurveyQuestionReportingTypeName": "POP",
"Number": "10",
"Letter": null
},
{
"DisplayName": "Would you like someone to follow-up with you? If so, please explain below.",
"SurveyFieldName": "Explain follow up request",
"FieldValue": "",
"FieldWeight": null,
"DisplayOrder": 25,
"InputTypeName": "Free Text Area",
"SurveyQuestionReportingTypeName": "Feedback",
"Number": "11",
"Letter": null
},
{
"DisplayName": "What is the email address we should utilize if we need to contact you about important updates?",
"SurveyFieldName": "Owner Email Address",
"FieldValue": "jdoe@example.com",
"FieldWeight": null,
"DisplayOrder": 99,
"InputTypeName": "Validated Free Text Area",
"SurveyQuestionReportingTypeName": null,
"Number": "12",
"Letter": null
}
],
"Dealer":{
"Id":1747,
"Name":"ABC Outdoor Power",
"MfgDealerNbr":"123abc",
"MfgDealerSubNbr":null,
"DealerNbr":"123abc",
"Contact":"null null",
"EMail":"ABCOutdoor@rollickoutdoor.com",
"EmailCC":null,
"WebsiteUrl":"www.ABCoutdoorpwr.com",
"Address1":"17269 U.S. 59",
"Address2":"",
"City":"Thief River Falls",
"State":"MN",
"PostalCode":"56701",
"County":null,
"Country":null,
"CountryCode":"US",
"Phone":"123-456-7573",
"Fax":"",
"TollFree":null,
"FIPSCode":null,
"CensusCode":null,
"GeoResult":null,
"LangCode":null,
"IsActive":false,
"IsPoorPerformer":false,
"IsLeadHeld":false,
"IsPsiDisabled":null,
"IsNurtureStreamDisabled":null,
"ManufacturerCode":"TXT",
"DealerTypeCode":"S",
"ContactPreferenceCode":null,
"ApplicationContextCode":"B",
"DealerGroupCode":null,
"SalespersonAssignmentTypeCode":"Standard",
"Latitude":48.126324,
"Longitude":-96.209627,
"CreateDate":"2021-03-03T03:58:37.343",
"UpdateDate":null,
"ManufacturerId":1,
"Customs":[
{
"FieldName": "CustomField1",
"FieldValue": "Value1"
},
{
"FieldName": "CustomField2",
"FieldValue": "Value2"
}
],
"TerritoryName":"Unassigned",
"TerritoryCode":"Unassigned",
"TerritoryHierarchyId":49,
"RegionName":"Unassigned",
"RegionCode":"Unassigned",
"RegionHierarchyId":48,
"DistrictName":null,
"DistrictCode":null,
"DistrictHierarchyId":null
},
"Owner":{
"Id":69752,
"FirstName":"John",
"LastName":"Doe",
"Title":null,
"Address1":"111 EAST 2ND ST",
"Address2":null,
"City":"Sunville",
"State":"MN",
"PostalCode":"56713",
"CountryCode":"US",
"HomePhone":null,
"WorkPhone":null,
"Email":null
},
"Product":{
"Id":808,
"Name":"Product 1",
"BrandCode":"ARC",
"BrandName":"BR 1",
"ManufacturerPlantCode":null,
"ProductTypeCode":"T1",
"ProductTypeName":"Type 1",
"SkuCode":null,
"Model":"PC1",
"ModelYear":2022,
"Code":"PC1",
"DisplayOrder":0,
"IsActive":true,
"ApplicationContextCode":"O",
"CreateDate":"2021-02-13T20:00:29.273",
"UpdateDate":"2021-10-08T15:14:14.013",
"ProductCategoryCode":" ",
"ProductCategoryName":"BLANK",
"ProductCategoryFlattenedCode":null,
"ProductCategoryFlattenedName":"BLANK",
"ProductCategoryId":661,
"Customs":[
{
"FieldName": "CustomField1",
"FieldValue": "Value1"
},
{
"FieldName": "CustomField2",
"FieldValue": "Value2"
}
]
},
"SurveyKey":{
"SurveyKeyUid":"d21c646d-5e99-44bd-a1ec-959914b93903",
"Id":47160,
"SurveyDate":null,
"ResponseDate":"2022-03-04T04:05:12.56",
"WarrantyClaimNumber":null,
"SurveyTypeName":"Initial Quality Survey",
"SurveyTypeCode":"R0",
"SurveyCategoryCode":"R",
"SurveyCategoryName":"Initial Ownership Survey",
"SurveyLanguageCode":"English"
},
"SurveyForm":{
"Id":7,
"FormName":"Initial Survey"
},
"Registration":{
"Id":84775,
"RegistrationHistoryId":100562,
"SerialNumber":"111112JH6NT102657",
"PurchaseDate":"2021-12-30T00:00:00",
"Customs":[
]
}
}
}