Purpose: This endpoint will allow you to get any Survey results for the client listed.
Simple Use Case: Returning Survey results for clients.
Scope and Outputs: This endpoint will allow you to review the Stress Test on a specific client. This does not make any updates to the portfolio.
Process Overview: Use the endpoint to GET the data for the household in question.
Process Steps:
- GET /Integrations/HiddenLevers/GetSurveyResults?clientId={OrionRiskClientID}
- Review Return Payload: sample below
{
"surveyCategory": null,
"currentSurveyId": null,
"surveys": null,
"userid": null,
"ownerOrg": null,
"hasRiskScore": null,
"ownerName": null,
"id": null,
"riskScore": null,
"surveyDate": null,
"surveySource": null,
"ownerEmail": null,
"createdDate": null,
"createdBy": null,
"name": null,
"surveyScore": null,
"lastModified": null,
"surveyRiskCategory": null,
"error": null,
"haserror": true
}
GET
/Integrations/HiddenLevers/GetSurveyResults?clientId=6602595
Result
{
"surveyCategory": null,
"currentSurveyId": null,
"surveys": [],
"userid": 20057,
"ownerOrg": 10497,
"hasRiskScore": "n",
"ownerName": "Lori Beaune",
"id": 6602595,
"riskScore": null,
"surveyDate": null,
"surveySource": null,
"ownerEmail": "lori.beaune@orion.com",
"createdDate": "2023-05-26 12:40:49.0",
"createdBy": 20057,
"name": "George Washington",
"surveyScore": null,
"lastModified": "2023-05-26 12:40:49.0",
"surveyRiskCategory": "",
"error": null,
"haserror": false
}
Process Tips or Controls:
- Requesting a client ID that does not have a survey will yield a result with Null values for the survey data as shown in the sample result.