Answer Metadata Update
Answer Metadata
The Kit and Profile APIs now have the option to retrieve metadata about each answer. Both APIs include a new parameter: includeMetadata=true.
Answer metadata is included as a suffixed answer key with __meta as the suffix. For example:
{
"Example_1": "1%",
"Example_1__meta": {
"lastUpdateOn": "2024-02-28T06:34:50.874Z",
"lastUpdatedBy": {
"_id": "5be48c6e091b2d5ffac5afe8",
"email": "[email protected]",
"name": "Aaron Example"
},
"overrideScore": 3,
"overrideRisk": "Medium",
"overrideNotes": "Mike overrode this",
"overrideBy": {
"name": "Mike",
"email": "[email protected]",
"_id": "5d8b797ef2377b626326b0ce",
"phoneNumber": "+18015555595",
"phoneNumberInfo": {
"country": "US",
"countryCallingCode": "1",
"nationalNumber": "8015555595",
"number": "+18015555595",
"__countryCallingCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN"
}
},
"overrideOn": "2024-05-13T23:17:06.653Z",
"question": {
"label": "An example question label",
"type": "number",
"isCalculated": false
},
"score": "0",
"maxScore": "4",
"risk": "Low"
}
}
Value Translation Options
The Kit and Profile APIs now include an option to disable value translation for a specific set of answer keys.
The new parameter, noTranslateValues takes a comma-delimited list of answer keys and will cause those answers to not be translated to their display values (e.g. US vs United States).
This allows API clients to use translateValues=true in conjunction with noTranslateValues=Entity_Country to disable value translation for specific fields.
Task API Updates
The Task API payload now includes kitId and kitType indicating if this task is associated with a particular kit.
kitId and kitType are also available as query parameters for the GET /tasks API.