Assessment response

Get assessment responses with pagination for provider

get

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

assessmentIdintegerOptional

ID of the assessment

Example: 1

assessmentNamestringOptional

Name of the assessment

Example: Math Assessment

assessmentNameFilterModestring · enumOptional

Filter mode for assessment name

Default: exactExample: exactPossible values:

assessmentTitlestringOptional

Title of the assessment

Example: Final Exam

assessmentTitleFilterModestring · enumOptional

Filter mode for assessment title

Default: exactExample: partialPossible values:

isConsentbooleanOptional

Flag to include assessment that are consents

Example: true

pageNumberintegerOptional

Page number for pagination

Default: 1Example: 1

appointmentIdintegerOptional

ID of the appointment

Default: 1Example: 1

pageSizeintegerOptional

Page size for pagination

Default: 10Example: 10

statusstring[]Optional

Status of the assessment

Default: []Example: ["active","inactive"]

orderBystringOptional

Field to order by

Example: createdAt

orderDirectionstringOptional

Direction of ordering

Default: ascExample: desc

mapResSchemaWithPlatformbooleanOptional

Flag to identify the version

Example: true

populationTagsnumber[]Optional

List of tags to filter assessments

Default: []Example: [1,2,3]

Responses

200Success

application/json

get

/api/assessment-response

HTTPcURLJavaScriptPython

GET /api/assessment-response HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalRecords": 100,
  "totalPages": 10,
  "assessments": []
}