Survey response

Get assessments by id

get
Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
surveyResponseIdnumberRequiredPattern: [^\/#\?]+?
Query parameters
completedstringOptional
surveyNamestringOptional
isConsentbooleanOptional

Indicates if response has to be fetched for consent type survey or not

Example: true
surveyNameFilterModestring · enumOptionalPossible values:
surveyTitlestringOptional
surveyTitleFilterModestring · enumOptionalPossible values:
surveyIdintegerOptional
surveyIdsinteger[]Optional
appointmentIdintegerOptional

ID of the appointment

Default: 1Example: 1
organizationIdintegerOptional
personIdintegerOptional
orderBystringOptional
orderDirectionstringOptional
populationTagsinteger[]Optional
pageNumberintegerOptional
pageSizeintegerOptional
skipPaginationbooleanOptional
consumerInfobooleanOptional
dateone ofOptional

Date to filter responses by

string · dateOptional
or
string · date-timeOptional
consumerUuidstringOptional
classanyRequired
Responses
get
/api/consumer/survey-response/{surveyResponseId}
200Success

update survey response

put
Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
surveyResponseIdnumberRequiredPattern: [^\/#\?]+?
Query parameters
finalSubmissionbooleanOptional
Body
idintegerOptional
consumerEpisodeIntakeIdintegerOptional
surveyIdintegerOptional
organizationIdintegerOptional
personIdintegerOptional
appointmentIdintegerOptional
textobjectOptional
metaobjectOptional
identifierobjectOptional
subjectobjectOptional
encounterobjectOptional
authorobjectOptional
sourceobjectOptional
containedobject[]Optional
basedOnobject[]Optional
partOfobject[]Optional
implicitRulesstringOptional
languagestringOptional
questionnairestringOptional
authoredone ofOptional
string · dateOptional
or
string · date-timeOptional
statusstring · enumOptionalPossible values:
extensionobject[]Optional
attributesobjectOptional
assessmentResponseobjectOptional
assignedServiceProvidersanyOptional
updatedByobjectOptional
consumerUuidstringOptional
workflowAutomationTaskExecutionIdintegerOptional
Responses
put
/api/consumer/survey-response/{surveyResponseId}
200Success