AssessmentApi | NexPort User Documentation

Gets a list of test attempts for the given section enrollment and assignment. Results are ordered by attempt index from highest (most recent attempt) to lowest (least recent attempt). Requires at least one of the following: User has View Section Enrollments permission in enrollment organization or an ancestor OR User has Update Section Enrollments permission in enrollment organization or an ancestor OR User is an instructor for the section that the assignment is in.

get

Query parameters

enrollment_idstring · uuidRequired

assignment_idstring · uuidRequired

pageinteger · int32Optional

Which page of results to start on

per_pageinteger · int32Optional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of test attempts

Contains details of a test attempt

attempt_idstring · uuidRequired

Id of this test attempt

Example: 00000000-0000-0000-0000-000000000000

attempt_indexinteger · int32Required

Which attempt number this is. Index is ZERO BASED.

start_datestring · date-timeOptional

When the student started this attempt (in UTC)

last_time_left_updatestring · date-timeOptional

When the TimeLeft field was last modified

finish_datestring · date-timeOptional

When the student completed this attempt (in UTC)

allow_relaunchbooleanRequired

Whether or not the student can relaunch the test after exiting without finishing

time_leftstringOptional

How much time the student has remaining to complete this attempt

num_questionsinteger · int32Required

The number of questions that this attempt was created with

is_completebooleanRequired

Has this attempt been submitted?

scorenumber · doubleOptional

The score for this attempt or null if is_complete is set to false

commentsstringOptional

Any additional comments from the student for this test attempt.

403

Not authorized to view test attempts

409

Entity not found

422

Validation exception. See response body for more info.

get

/api/v1/AssessmentApi/GetTestAttempts

GET /api/v1/AssessmentApi/GetTestAttempts?enrollment_id=123e4567-e89b-12d3-a456-426614174000&assignment_id=123e4567-e89b-12d3-a456-426614174000&access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

[
  {
    "attempt_id": "00000000-0000-0000-0000-000000000000",
    "attempt_index": 1,
    "start_date": "2026-03-02T22:33:04.770Z",
    "last_time_left_update": "2026-03-02T22:33:04.770Z",
    "finish_date": "2026-03-02T22:33:04.770Z",
    "allow_relaunch": true,
    "time_left": "text",
    "num_questions": 1,
    "is_complete": true,
    "score": 1,
    "comments": "text",
    "proctor_response_item": {
      "proctor_id": "00000000-0000-0000-0000-000000000000",
      "proctor_user_id": "00000000-0000-0000-0000-000000000000",
      "proctor_code": "text",
      "proctor_first_name": "text",
      "proctor_last_name": "text",
      "organization_access_code_id": "00000000-0000-0000-0000-000000000000",
      "access_code": "text",
      "date_proctored": "2026-03-02T22:33:04.770Z",
      "api_error_entity": {
        "error_code": 0,
        "error_message": "text",
        "warning_messages": [
          "text"
        ]
      }
    },
    "api_error_entity": {
      "error_code": 0,
      "error_message": "text",
      "warning_messages": [
        "text"
      ]
    }
  }
]

Gets a list of student responses for a test or survey assignment. To get results for a test attempt, use test_attempt_id. For a survey, use assignment_status_id OR assignment_id+enrollment_id. Results are arranged by answer display order. Requires the View Users and View Section Enrollments permission in the enrollment org or an ancestor.

get

Query parameters

test_attempt_idstring · uuidOptional

assignment_status_idstring · uuidOptional

assignment_idstring · uuidOptional

enrollment_idstring · uuidOptional

pageinteger · int32Optional

Which page of results to start on

per_pageinteger · int32Optional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of student responses

Contains a list of responses for a particular student for a given test/survey assignment

403

Not authorized to view student responses

409

Entity not found

422

Validation exception

get

/api/v1/AssessmentApi/GetTestSurveyResults

GET /api/v1/AssessmentApi/GetTestSurveyResults?access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "test_survey_results": [
    {
      "option_ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "question_id": "00000000-0000-0000-0000-000000000000",
      "answer_id": "00000000-0000-0000-0000-000000000000",
      "is_answered": true,
      "is_skipped": true,
      "is_bookmarked": true,
      "display_order": 1,
      "open_ended_answer": "text",
      "utc_date_created": "2026-03-02T22:33:04.770Z",
      "chosen_option_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Gets the text for a test question, as well as the type of question that it is. Requires the View Users and View Section Enrollments permissions in the org or ancestor in which the question bank containing the question exists, or, if enrollment_id is passed in, it requires the aforementioned permissions in the enrollment organization. The question must exist in a question bank that a test in the enrollment section utilizes.

get

Query parameters

question_idstring · uuidRequired

enrollment_idstring · uuidOptional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

Question text and type

Contains text for a question and what type of question it is

open_ended_question_textstringOptional

The text for the open ended question (if applicable)

question_textstringOptional

The text for the question (if it is not strictly open ended)

question_typeinteger · enumRequired

What type of question this is. SingleSelect=1; MultiSelect=2; FivePointScale=3;1 = SingleSelect, 2 = MultiSelect, 3 = FivePointScale

Possible values:

403

Not authorized to view test/survey questions

409

Entity not found

422

Validation exception. See response body for more info.

get

/api/v1/AssessmentApi/GetQuestion

GET /api/v1/AssessmentApi/GetQuestion?question_id=123e4567-e89b-12d3-a456-426614174000&access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "open_ended_question_text": "text",
  "question_text": "text",
  "question_type": 1,
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Get text for a particular test or survey question option, as well as whether it is correct or not. Requires the View Users and View Section Enrollments permissions in the org or ancestor in which the question bank containing the question and option exists, or, if enrollment_id is passed in, it requires the aforementioned permissions in the enrollment organization. The question option must exist in a question bank that a test in the enrollment section utilizes.

get

Query parameters

question_option_idstring · uuidRequired

enrollment_idstring · uuidOptional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

Question option text and if it is correct

Contains the text for a given test or survey question option and if it is correct

option_textstringRequired

Test/survey question option text

is_correctbooleanRequired

Whether or not this option has been marked as a correct answer

403

Not authorized to view question options

409

Entity not found

422

Validation exception. See response body for more info.

get

/api/v1/AssessmentApi/GetQuestionOption

GET /api/v1/AssessmentApi/GetQuestionOption?question_option_id=123e4567-e89b-12d3-a456-426614174000&access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "option_text": "text",
  "is_correct": true,
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Get ids for all test questions tied to a given test or survey assignment. Requires the View Users and View Section Enrollments permissions in the organization (or ancestor) that the assignment exists in.

get

Query parameters

assignment_idstring · uuidRequired

pageinteger · int32Optional

Which page of results to start on

per_pageinteger · int32Optional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

List of question ids

Contains ids for all the questions tied to a particular test or survey assignment

question_idsstring · uuid[]Optional

List of question ids

403

Not authorized to view question ids

409

Entity not found

422

Validation exception. See response body for more info.

get

/api/v1/AssessmentApi/GetQuestionIds

GET /api/v1/AssessmentApi/GetQuestionIds?assignment_id=123e4567-e89b-12d3-a456-426614174000&access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "question_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Get question text and all responses for that question, as well as the date that the answer was created (which is based off the test attempt start date for that question or the assignment status creation date if the test attempt start date is null for whatever reason). Results are ordered by answer creation date. Requires the View Users and View Section Enrollments permissions in the organization (or ancestor) that the question bank containing the question exists in.

get

Query parameters

question_idstring · uuidRequired

utc_start_datestring · date-timeOptional

utc_finish_datestring · date-timeOptional

pageinteger · int32Optional

Which page of results to start on

per_pageinteger · int32Optional

access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Responses

200

Question text and list of student responses

Contains the question text and all the responses for a particular test/survey question

option_idsstring · uuid[]Optional

List of ids for possible options on this question (if it is not strictly open ended). Match these ids up with the option ids from GetQuestionOption to get the option text.

403

Not authorized to view student responses

409

Entity not found

422

Validation exception

get

/api/v1/AssessmentApi/GetStudentResponses

GET /api/v1/AssessmentApi/GetStudentResponses?question_id=123e4567-e89b-12d3-a456-426614174000&access_token=text HTTP/1.1
Host: www.nexportcampus.com
Accept: */*

{
  "question_response": {
    "open_ended_question_text": "text",
    "question_text": "text",
    "question_type": 1,
    "api_error_entity": {
      "error_code": 0,
      "error_message": "text",
      "warning_messages": [
        "text"
      ]
    }
  },
  "option_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "student_response_list": [
    {
      "question_id": "00000000-0000-0000-0000-000000000000",
      "answer_id": "00000000-0000-0000-0000-000000000000",
      "is_answered": true,
      "is_skipped": true,
      "is_bookmarked": true,
      "display_order": 1,
      "open_ended_answer": "text",
      "utc_date_created": "2026-03-02T22:33:04.770Z",
      "chosen_option_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

hashtagGet ids for all test questions tied to a given test or survey assignment. Requires the View Users and View Section Enrollments permissions in the organization (or ancestor) that the assignment exists in.

Get ids for all test questions tied to a given test or survey assignment. Requires the View Users and View Section Enrollments permissions in the organization (or ancestor) that the assignment exists in.