Assessments API: Answers

Retrieves one specific attempt

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

attemptstring · uuidRequired

Responses

200

OK

application/jsontext/json

AttemptIdstring · uuidOptional

AttemptNumberinteger · int32Optional

FormCodestring · nullableOptional

FormIdstring · uuidOptional

FormNamestring · nullableOptional

RegistrationIdstring · uuid · nullableOptional

AssessorUserIdstring · uuidOptional

GradingAssessorUserIdstring · uuid · nullableOptional

LearnerUserIdstring · uuidOptional

AttemptGradestring · nullableOptional

AttemptIsPassingbooleanOptional

AttemptStatusstring · nullableOptional

AttemptTagstring · nullableOptional

AttemptDurationnumber · double · nullableOptional

AttemptPointsnumber · double · nullableOptional

AttemptScorenumber · double · nullableOptional

FormPointsnumber · double · nullableOptional

ActiveQuestionIndexinteger · int32 · nullableOptional

ActiveSectionIndexinteger · int32 · nullableOptional

FormSectionsCountinteger · int32 · nullableOptional

SectionsAsTabsEnabledbooleanOptional

SingleQuestionPerTabEnabledbooleanOptional

TabNavigationEnabledbooleanOptional

TabTimeLimitstring · nullableOptional

AttemptLanguagestring · nullableOptional

AttemptPingIntervalinteger · int32 · nullableOptional

AttemptTimeLimitinteger · int32 · nullableOptional

UserAgentstring · nullableOptional

AttemptGradedstring · date-time · nullableOptional

AttemptImportedstring · date-time · nullableOptional

AttemptPingedstring · date-time · nullableOptional

AttemptStartedstring · date-time · nullableOptional

AttemptSubmittedstring · date-time · nullableOptional

404

Not Found

application/jsontext/json

get/api/assessments/attempts/{attempt}

HTTPcURLJavaScriptPython

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

{
  "AttemptId": "123e4567-e89b-12d3-a456-426614174000",
  "AttemptNumber": 1,
  "FormCode": "text",
  "FormId": "123e4567-e89b-12d3-a456-426614174000",
  "FormName": "text",
  "RegistrationId": "123e4567-e89b-12d3-a456-426614174000",
  "AssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "GradingAssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "LearnerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "AttemptGrade": "text",
  "AttemptIsPassing": true,
  "AttemptStatus": "text",
  "AttemptTag": "text",
  "AttemptDuration": 1,
  "AttemptPoints": 1,
  "AttemptScore": 1,
  "FormPoints": 1,
  "ActiveQuestionIndex": 1,
  "ActiveSectionIndex": 1,
  "FormSectionsCount": 1,
  "SectionsAsTabsEnabled": true,
  "SingleQuestionPerTabEnabled": true,
  "TabNavigationEnabled": true,
  "TabTimeLimit": "text",
  "AttemptLanguage": "text",
  "AttemptPingInterval": 1,
  "AttemptTimeLimit": 1,
  "UserAgent": "text",
  "AttemptGraded": "2026-07-13T01:38:12.090Z",
  "AttemptImported": "2026-07-13T01:38:12.090Z",
  "AttemptPinged": "2026-07-13T01:38:12.090Z",
  "AttemptStarted": "2026-07-13T01:38:12.090Z",
  "AttemptSubmitted": "2026-07-13T01:38:12.090Z"
}

Checks for the existence of one specific attempt

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

attemptstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

head/api/assessments/attempts/{attempt}

HTTPcURLJavaScriptPython

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

No content

Collects the list of attempts that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

AttemptStatusstring · nullableOptional

AttemptGradedSincestring · date-time · nullableOptional

AttemptGradedBeforestring · date-time · nullableOptional

AttemptImportedSincestring · date-time · nullableOptional

AttemptImportedBeforestring · date-time · nullableOptional

AttemptPingedSincestring · date-time · nullableOptional

AttemptPingedBeforestring · date-time · nullableOptional

AttemptStartedSincestring · date-time · nullableOptional

AttemptStartedBeforestring · date-time · nullableOptional

AttemptSubmittedSincestring · date-time · nullableOptional

AttemptSubmittedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

AttemptIdstring · uuidOptional

AttemptNumberinteger · int32Optional

FormCodestring · nullableOptional

FormIdstring · uuidOptional

FormNamestring · nullableOptional

RegistrationIdstring · uuid · nullableOptional

AssessorUserIdstring · uuidOptional

GradingAssessorUserIdstring · uuid · nullableOptional

LearnerUserIdstring · uuidOptional

AttemptGradestring · nullableOptional

AttemptIsPassingbooleanOptional

AttemptStatusstring · nullableOptional

AttemptTagstring · nullableOptional

AttemptDurationnumber · double · nullableOptional

AttemptPointsnumber · double · nullableOptional

AttemptScorenumber · double · nullableOptional

FormPointsnumber · double · nullableOptional

ActiveQuestionIndexinteger · int32 · nullableOptional

ActiveSectionIndexinteger · int32 · nullableOptional

FormSectionsCountinteger · int32 · nullableOptional

SectionsAsTabsEnabledbooleanOptional

SingleQuestionPerTabEnabledbooleanOptional

TabNavigationEnabledbooleanOptional

TabTimeLimitstring · nullableOptional

AttemptLanguagestring · nullableOptional

AttemptPingIntervalinteger · int32 · nullableOptional

AttemptTimeLimitinteger · int32 · nullableOptional

UserAgentstring · nullableOptional

AttemptGradedstring · date-time · nullableOptional

AttemptImportedstring · date-time · nullableOptional

AttemptPingedstring · date-time · nullableOptional

AttemptStartedstring · date-time · nullableOptional

AttemptSubmittedstring · date-time · nullableOptional

post/api/assessments/attempts/collect

HTTPcURLJavaScriptPython

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

{
  "AttemptStatus": "text",
  "AttemptGradedSince": "2026-07-13T01:38:12.090Z",
  "AttemptGradedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptImportedSince": "2026-07-13T01:38:12.090Z",
  "AttemptImportedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptPingedSince": "2026-07-13T01:38:12.090Z",
  "AttemptPingedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptStartedSince": "2026-07-13T01:38:12.090Z",
  "AttemptStartedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptSubmittedSince": "2026-07-13T01:38:12.090Z",
  "AttemptSubmittedBefore": "2026-07-13T01:38:12.090Z"
}

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

200

OK

[
  {
    "AttemptId": "123e4567-e89b-12d3-a456-426614174000",
    "AttemptNumber": 1,
    "FormCode": "text",
    "FormId": "123e4567-e89b-12d3-a456-426614174000",
    "FormName": "text",
    "RegistrationId": "123e4567-e89b-12d3-a456-426614174000",
    "AssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
    "GradingAssessorUserId": "123e4567-e89b-12d3-a456-426614174000",
    "LearnerUserId": "123e4567-e89b-12d3-a456-426614174000",
    "AttemptGrade": "text",
    "AttemptIsPassing": true,
    "AttemptStatus": "text",
    "AttemptTag": "text",
    "AttemptDuration": 1,
    "AttemptPoints": 1,
    "AttemptScore": 1,
    "FormPoints": 1,
    "ActiveQuestionIndex": 1,
    "ActiveSectionIndex": 1,
    "FormSectionsCount": 1,
    "SectionsAsTabsEnabled": true,
    "SingleQuestionPerTabEnabled": true,
    "TabNavigationEnabled": true,
    "TabTimeLimit": "text",
    "AttemptLanguage": "text",
    "AttemptPingInterval": 1,
    "AttemptTimeLimit": 1,
    "UserAgent": "text",
    "AttemptGraded": "2026-07-13T01:38:12.090Z",
    "AttemptImported": "2026-07-13T01:38:12.090Z",
    "AttemptPinged": "2026-07-13T01:38:12.090Z",
    "AttemptStarted": "2026-07-13T01:38:12.090Z",
    "AttemptSubmitted": "2026-07-13T01:38:12.090Z"
  }
]

Counts the attempts that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

AttemptStatusstring · nullableOptional

AttemptGradedSincestring · date-time · nullableOptional

AttemptGradedBeforestring · date-time · nullableOptional

AttemptImportedSincestring · date-time · nullableOptional

AttemptImportedBeforestring · date-time · nullableOptional

AttemptPingedSincestring · date-time · nullableOptional

AttemptPingedBeforestring · date-time · nullableOptional

AttemptStartedSincestring · date-time · nullableOptional

AttemptStartedBeforestring · date-time · nullableOptional

AttemptSubmittedSincestring · date-time · nullableOptional

AttemptSubmittedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

Countinteger · int32Optional

Summarystring · nullableOptional

post/api/assessments/attempts/count

HTTPcURLJavaScriptPython

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

{
  "AttemptStatus": "text",
  "AttemptGradedSince": "2026-07-13T01:38:12.090Z",
  "AttemptGradedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptImportedSince": "2026-07-13T01:38:12.090Z",
  "AttemptImportedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptPingedSince": "2026-07-13T01:38:12.090Z",
  "AttemptPingedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptStartedSince": "2026-07-13T01:38:12.090Z",
  "AttemptStartedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptSubmittedSince": "2026-07-13T01:38:12.090Z",
  "AttemptSubmittedBefore": "2026-07-13T01:38:12.090Z"
}

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

AttemptStatusstring · nullableOptional

AttemptGradedSincestring · date-time · nullableOptional

AttemptGradedBeforestring · date-time · nullableOptional

AttemptImportedSincestring · date-time · nullableOptional

AttemptImportedBeforestring · date-time · nullableOptional

AttemptPingedSincestring · date-time · nullableOptional

AttemptPingedBeforestring · date-time · nullableOptional

AttemptStartedSincestring · date-time · nullableOptional

AttemptStartedBeforestring · date-time · nullableOptional

AttemptSubmittedSincestring · date-time · nullableOptional

AttemptSubmittedBeforestring · date-time · nullableOptional

Responses

200

OK

No content

post/api/assessments/attempts/download

HTTPcURLJavaScriptPython

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

{
  "AttemptStatus": "text",
  "AttemptGradedSince": "2026-07-13T01:38:12.090Z",
  "AttemptGradedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptImportedSince": "2026-07-13T01:38:12.090Z",
  "AttemptImportedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptPingedSince": "2026-07-13T01:38:12.090Z",
  "AttemptPingedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptStartedSince": "2026-07-13T01:38:12.090Z",
  "AttemptStartedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptSubmittedSince": "2026-07-13T01:38:12.090Z",
  "AttemptSubmittedBefore": "2026-07-13T01:38:12.090Z"
}

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

AttemptStatusstring · nullableOptional

AttemptGradedSincestring · date-time · nullableOptional

AttemptGradedBeforestring · date-time · nullableOptional

AttemptImportedSincestring · date-time · nullableOptional

AttemptImportedBeforestring · date-time · nullableOptional

AttemptPingedSincestring · date-time · nullableOptional

AttemptPingedBeforestring · date-time · nullableOptional

AttemptStartedSincestring · date-time · nullableOptional

AttemptStartedBeforestring · date-time · nullableOptional

AttemptSubmittedSincestring · date-time · nullableOptional

AttemptSubmittedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

AttemptIdstring · uuidOptional

post/api/assessments/attempts/search

HTTPcURLJavaScriptPython

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

{
  "AttemptStatus": "text",
  "AttemptGradedSince": "2026-07-13T01:38:12.090Z",
  "AttemptGradedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptImportedSince": "2026-07-13T01:38:12.090Z",
  "AttemptImportedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptPingedSince": "2026-07-13T01:38:12.090Z",
  "AttemptPingedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptStartedSince": "2026-07-13T01:38:12.090Z",
  "AttemptStartedBefore": "2026-07-13T01:38:12.090Z",
  "AttemptSubmittedSince": "2026-07-13T01:38:12.090Z",
  "AttemptSubmittedBefore": "2026-07-13T01:38:12.090Z"
}

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

200

OK

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