Evaluation API: Answers

Retrieves one specific attempt

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

attemptstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/attempts/{attempt}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/attempts/{attempt} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "assessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "attemptId": "123e4567-e89b-12d3-a456-426614174000",
  "formId": "123e4567-e89b-12d3-a456-426614174000",
  "gradingAssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "registrationId": "123e4567-e89b-12d3-a456-426614174000",
  "attemptIsPassing": true,
  "sectionsAsTabsEnabled": true,
  "singleQuestionPerTabEnabled": true,
  "tabNavigationEnabled": true,
  "attemptGrade": "text",
  "attemptLanguage": "text",
  "attemptStatus": "text",
  "attemptTag": "text",
  "tabTimeLimit": "text",
  "userAgent": "text",
  "activeQuestionIndex": 1,
  "activeSectionIndex": 1,
  "attemptNumber": 1,
  "attemptPingInterval": 1,
  "attemptTimeLimit": 1,
  "formSectionsCount": 1,
  "attemptDuration": 1,
  "attemptPoints": 1,
  "attemptScore": 1,
  "formPoints": 1,
  "attemptGraded": "2026-01-29T16:29:01.809Z",
  "attemptImported": "2026-01-29T16:29:01.809Z",
  "attemptPinged": "2026-01-29T16:29:01.809Z",
  "attemptStarted": "2026-01-29T16:29:01.809Z",
  "attemptSubmitted": "2026-01-29T16:29:01.809Z"
}

Checks for the existence of one specific attempt

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

attemptstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/attempts/{attempt}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/attempts/{attempt} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of attempts that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

assessorUserIdstring · uuid · nullableOptional

formIdstring · uuid · nullableOptional

gradingAssessorUserIdstring · uuid · nullableOptional

learnerUserIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

registrationIdstring · uuid · nullableOptional

attemptIsPassingboolean · nullableOptional

sectionsAsTabsEnabledboolean · nullableOptional

singleQuestionPerTabEnabledboolean · nullableOptional

tabNavigationEnabledboolean · nullableOptional

attemptGradestring · nullableOptional

attemptLanguagestring · nullableOptional

attemptStatusstring · nullableOptional

attemptTagstring · nullableOptional

tabTimeLimitstring · nullableOptional

userAgentstring · nullableOptional

activeQuestionIndexinteger · int32 · nullableOptional

activeSectionIndexinteger · int32 · nullableOptional

attemptNumberinteger · int32 · nullableOptional

attemptPingIntervalinteger · int32 · nullableOptional

attemptTimeLimitinteger · int32 · nullableOptional

formSectionsCountinteger · int32 · nullableOptional

attemptDurationnumber · double · nullableOptional

attemptPointsnumber · double · nullableOptional

attemptScorenumber · double · nullableOptional

formPointsnumber · double · nullableOptional

attemptGradedstring · date-time · nullableOptional

attemptImportedstring · date-time · nullableOptional

attemptPingedstring · date-time · nullableOptional

attemptStartedstring · date-time · nullableOptional

attemptSubmittedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/attempts/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/attempts/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1444

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:29:01.809Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "assessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "formId": "123e4567-e89b-12d3-a456-426614174000",
  "gradingAssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "registrationId": "123e4567-e89b-12d3-a456-426614174000",
  "attemptIsPassing": true,
  "sectionsAsTabsEnabled": true,
  "singleQuestionPerTabEnabled": true,
  "tabNavigationEnabled": true,
  "attemptGrade": "text",
  "attemptLanguage": "text",
  "attemptStatus": "text",
  "attemptTag": "text",
  "tabTimeLimit": "text",
  "userAgent": "text",
  "activeQuestionIndex": 1,
  "activeSectionIndex": 1,
  "attemptNumber": 1,
  "attemptPingInterval": 1,
  "attemptTimeLimit": 1,
  "formSectionsCount": 1,
  "attemptDuration": 1,
  "attemptPoints": 1,
  "attemptScore": 1,
  "formPoints": 1,
  "attemptGraded": "2026-01-29T16:29:01.809Z",
  "attemptImported": "2026-01-29T16:29:01.809Z",
  "attemptPinged": "2026-01-29T16:29:01.809Z",
  "attemptStarted": "2026-01-29T16:29:01.809Z",
  "attemptSubmitted": "2026-01-29T16:29:01.809Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "assessorUserId": "123e4567-e89b-12d3-a456-426614174000",
    "attemptId": "123e4567-e89b-12d3-a456-426614174000",
    "formId": "123e4567-e89b-12d3-a456-426614174000",
    "gradingAssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
    "learnerUserId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "registrationId": "123e4567-e89b-12d3-a456-426614174000",
    "attemptIsPassing": true,
    "sectionsAsTabsEnabled": true,
    "singleQuestionPerTabEnabled": true,
    "tabNavigationEnabled": true,
    "attemptGrade": "text",
    "attemptLanguage": "text",
    "attemptStatus": "text",
    "attemptTag": "text",
    "tabTimeLimit": "text",
    "userAgent": "text",
    "activeQuestionIndex": 1,
    "activeSectionIndex": 1,
    "attemptNumber": 1,
    "attemptPingInterval": 1,
    "attemptTimeLimit": 1,
    "formSectionsCount": 1,
    "attemptDuration": 1,
    "attemptPoints": 1,
    "attemptScore": 1,
    "formPoints": 1,
    "attemptGraded": "2026-01-29T16:29:01.809Z",
    "attemptImported": "2026-01-29T16:29:01.809Z",
    "attemptPinged": "2026-01-29T16:29:01.809Z",
    "attemptStarted": "2026-01-29T16:29:01.809Z",
    "attemptSubmitted": "2026-01-29T16:29:01.809Z"
  }
]

Counts the attempts that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

assessorUserIdstring · uuid · nullableOptional

formIdstring · uuid · nullableOptional

gradingAssessorUserIdstring · uuid · nullableOptional

learnerUserIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

registrationIdstring · uuid · nullableOptional

attemptIsPassingboolean · nullableOptional

sectionsAsTabsEnabledboolean · nullableOptional

singleQuestionPerTabEnabledboolean · nullableOptional

tabNavigationEnabledboolean · nullableOptional

attemptGradestring · nullableOptional

attemptLanguagestring · nullableOptional

attemptStatusstring · nullableOptional

attemptTagstring · nullableOptional

tabTimeLimitstring · nullableOptional

userAgentstring · nullableOptional

activeQuestionIndexinteger · int32 · nullableOptional

activeSectionIndexinteger · int32 · nullableOptional

attemptNumberinteger · int32 · nullableOptional

attemptPingIntervalinteger · int32 · nullableOptional

attemptTimeLimitinteger · int32 · nullableOptional

formSectionsCountinteger · int32 · nullableOptional

attemptDurationnumber · double · nullableOptional

attemptPointsnumber · double · nullableOptional

attemptScorenumber · double · nullableOptional

formPointsnumber · double · nullableOptional

attemptGradedstring · date-time · nullableOptional

attemptImportedstring · date-time · nullableOptional

attemptPingedstring · date-time · nullableOptional

attemptStartedstring · date-time · nullableOptional

attemptSubmittedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/attempts/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/attempts/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1444

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:29:01.809Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "assessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "formId": "123e4567-e89b-12d3-a456-426614174000",
  "gradingAssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "registrationId": "123e4567-e89b-12d3-a456-426614174000",
  "attemptIsPassing": true,
  "sectionsAsTabsEnabled": true,
  "singleQuestionPerTabEnabled": true,
  "tabNavigationEnabled": true,
  "attemptGrade": "text",
  "attemptLanguage": "text",
  "attemptStatus": "text",
  "attemptTag": "text",
  "tabTimeLimit": "text",
  "userAgent": "text",
  "activeQuestionIndex": 1,
  "activeSectionIndex": 1,
  "attemptNumber": 1,
  "attemptPingInterval": 1,
  "attemptTimeLimit": 1,
  "formSectionsCount": 1,
  "attemptDuration": 1,
  "attemptPoints": 1,
  "attemptScore": 1,
  "formPoints": 1,
  "attemptGraded": "2026-01-29T16:29:01.809Z",
  "attemptImported": "2026-01-29T16:29:01.809Z",
  "attemptPinged": "2026-01-29T16:29:01.809Z",
  "attemptStarted": "2026-01-29T16:29:01.809Z",
  "attemptSubmitted": "2026-01-29T16:29:01.809Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of attempts that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

assessorUserIdstring · uuid · nullableOptional

formIdstring · uuid · nullableOptional

gradingAssessorUserIdstring · uuid · nullableOptional

learnerUserIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

registrationIdstring · uuid · nullableOptional

attemptIsPassingboolean · nullableOptional

sectionsAsTabsEnabledboolean · nullableOptional

singleQuestionPerTabEnabledboolean · nullableOptional

tabNavigationEnabledboolean · nullableOptional

attemptGradestring · nullableOptional

attemptLanguagestring · nullableOptional

attemptStatusstring · nullableOptional

attemptTagstring · nullableOptional

tabTimeLimitstring · nullableOptional

userAgentstring · nullableOptional

activeQuestionIndexinteger · int32 · nullableOptional

activeSectionIndexinteger · int32 · nullableOptional

attemptNumberinteger · int32 · nullableOptional

attemptPingIntervalinteger · int32 · nullableOptional

attemptTimeLimitinteger · int32 · nullableOptional

formSectionsCountinteger · int32 · nullableOptional

attemptDurationnumber · double · nullableOptional

attemptPointsnumber · double · nullableOptional

attemptScorenumber · double · nullableOptional

formPointsnumber · double · nullableOptional

attemptGradedstring · date-time · nullableOptional

attemptImportedstring · date-time · nullableOptional

attemptPingedstring · date-time · nullableOptional

attemptStartedstring · date-time · nullableOptional

attemptSubmittedstring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/evaluation/attempts/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/attempts/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1444

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:29:01.809Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "assessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "formId": "123e4567-e89b-12d3-a456-426614174000",
  "gradingAssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "registrationId": "123e4567-e89b-12d3-a456-426614174000",
  "attemptIsPassing": true,
  "sectionsAsTabsEnabled": true,
  "singleQuestionPerTabEnabled": true,
  "tabNavigationEnabled": true,
  "attemptGrade": "text",
  "attemptLanguage": "text",
  "attemptStatus": "text",
  "attemptTag": "text",
  "tabTimeLimit": "text",
  "userAgent": "text",
  "activeQuestionIndex": 1,
  "activeSectionIndex": 1,
  "attemptNumber": 1,
  "attemptPingInterval": 1,
  "attemptTimeLimit": 1,
  "formSectionsCount": 1,
  "attemptDuration": 1,
  "attemptPoints": 1,
  "attemptScore": 1,
  "formPoints": 1,
  "attemptGraded": "2026-01-29T16:29:01.809Z",
  "attemptImported": "2026-01-29T16:29:01.809Z",
  "attemptPinged": "2026-01-29T16:29:01.809Z",
  "attemptStarted": "2026-01-29T16:29:01.809Z",
  "attemptSubmitted": "2026-01-29T16:29:01.809Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of attempts that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

assessorUserIdstring · uuid · nullableOptional

formIdstring · uuid · nullableOptional

gradingAssessorUserIdstring · uuid · nullableOptional

learnerUserIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

registrationIdstring · uuid · nullableOptional

attemptIsPassingboolean · nullableOptional

sectionsAsTabsEnabledboolean · nullableOptional

singleQuestionPerTabEnabledboolean · nullableOptional

tabNavigationEnabledboolean · nullableOptional

attemptGradestring · nullableOptional

attemptLanguagestring · nullableOptional

attemptStatusstring · nullableOptional

attemptTagstring · nullableOptional

tabTimeLimitstring · nullableOptional

userAgentstring · nullableOptional

activeQuestionIndexinteger · int32 · nullableOptional

activeSectionIndexinteger · int32 · nullableOptional

attemptNumberinteger · int32 · nullableOptional

attemptPingIntervalinteger · int32 · nullableOptional

attemptTimeLimitinteger · int32 · nullableOptional

formSectionsCountinteger · int32 · nullableOptional

attemptDurationnumber · double · nullableOptional

attemptPointsnumber · double · nullableOptional

attemptScorenumber · double · nullableOptional

formPointsnumber · double · nullableOptional

attemptGradedstring · date-time · nullableOptional

attemptImportedstring · date-time · nullableOptional

attemptPingedstring · date-time · nullableOptional

attemptStartedstring · date-time · nullableOptional

attemptSubmittedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/attempts/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/attempts/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1444

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:29:01.809Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "assessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "formId": "123e4567-e89b-12d3-a456-426614174000",
  "gradingAssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "registrationId": "123e4567-e89b-12d3-a456-426614174000",
  "attemptIsPassing": true,
  "sectionsAsTabsEnabled": true,
  "singleQuestionPerTabEnabled": true,
  "tabNavigationEnabled": true,
  "attemptGrade": "text",
  "attemptLanguage": "text",
  "attemptStatus": "text",
  "attemptTag": "text",
  "tabTimeLimit": "text",
  "userAgent": "text",
  "activeQuestionIndex": 1,
  "activeSectionIndex": 1,
  "attemptNumber": 1,
  "attemptPingInterval": 1,
  "attemptTimeLimit": 1,
  "formSectionsCount": 1,
  "attemptDuration": 1,
  "attemptPoints": 1,
  "attemptScore": 1,
  "formPoints": 1,
  "attemptGraded": "2026-01-29T16:29:01.809Z",
  "attemptImported": "2026-01-29T16:29:01.809Z",
  "attemptPinged": "2026-01-29T16:29:01.809Z",
  "attemptStarted": "2026-01-29T16:29:01.809Z",
  "attemptSubmitted": "2026-01-29T16:29:01.809Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "attemptIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]