getAssessmentForms

Retrieves a list of all assessment forms supported by the system.

INFO

With no parameters, this endpoint returns all assessments (and their fields). When assessmentUuid is supplied, it returns a single assessment in the array.

Request

GET /rest/refdata/assessment-forms

Query Parameters

Parameter	Type	Required	Description
assessmentUuid	string	No	UUID of a specific self-assessment form. If omitted, returns all assessments.

Examples

GET /rest/refdata/assessment-forms
GET /rest/refdata/assessment-forms?assessmentUuid=79da1cd0-4ace-4ec8-b88d-de5acdc0f92a

Response

200 OK

[
  {
    "assessmentId": 1,
    "assessmentUuid": "79da1cd0-4ace-4ec8-b88d-de5acdc0f92a",
    "assessmentName": "Patient Health Questionnaire",
    "fields": []
  }
]

Field	Type	Description
assessmentId	integer	Primary key of the assessment
assessmentUuid	string	UUID identifier
assessmentName	string	Name of the assessment form
fields	array	List of fields/questions in this assessment

Errors

Exception	Cause
WSRefDataServiceException	Service error while fetching assessment forms