Articles in this section

API - External Resources Configuration Guide

Overview

ProctorU has enhanced its exam scheduling API to support external resources configuration through a new pre-checks user interface. This update allows you to specify which materials and tools test takers can use during their proctored exams.

Important: Any resource not explicitly listed as permitted will not be allowed during the exam session. Both candidates and proctors will review the permitted materials before the exam begins.

What's New

Updated API Endpoints

The following scheduling endpoints now support external resources parameters:

  • addBlueBirdExam
  • addAdHocProcess
  • editTermExam
  • batchSchedule

New Parameters

permitted_resources_list - A comma-separated list of allowed resources from the predefined options below

other_resources - Custom text field for resources not covered by the predefined list

Available External Resources

You can specify any of these resources in the permitted_resources_list parameter:

Calculators

  • computer_calculator
  • financial_calculator
  • four_function_calculator
  • graphing_calculator
  • online_calculator
  • scientific_calculator

Notes and Documents

  • excel_notes
  • formula_sheet
  • handwritten_notes
  • note_cards
  • notepad
  • pdf_notes
  • powerpoint_notes
  • printed_notes
  • word_notes

Software Applications

  • excel
  • paint
  • powerpoint
  • spss
  • word

Study Materials

  • ebook_computer
  • ebook_website
  • textbook

Writing Surfaces

  • scratch1
  • scratch2
  • scratch_more
  • whiteboard

Web Access

  • all_websites
  • approved_website (use with whitelist_urls parameter)
  • course_website

Other

  • bathroom_breaks

API Request Examples

Individual Exam Scheduling

# AddAdHoc, AddBlueBird, or editTermExam
curl --location --request POST 'https://api.proctoru.com/api/addAdHocProcess/' \
--data-urlencode 'permitted_resources_list=financial_calculator,printed_notes,pdf_notes,scratch1' \
--data-urlencode 'other_resources=Custom text field shown to test takers.'

Batch Scheduling

curl --location --request POST 'https://api.proctoru.com/api/batch/scheduling' \
--data-raw '{
  "exam": {
    "permitted_resources_list": "financial_calculator,printed_notes,pdf_notes,scratch1",
    "other_resources": "Custom text field shown to test takers."
  },
  "test_takers": [
    {
      // test taker details
    }
  ]
}'

Best Practices

Resource Configuration

  • Use predefined resources when possible - ProctorU's future AI detection capabilities will only support predefined resource types
  • Only use other_resources for exceptions - Use this field only when needed resources aren't available in the predefined list
  • No need to list prohibited items - If no resources are permitted, simply omit the field

Website Access

  • For specific URLs: Use approved_website with the whitelist_urls parameter
  • For general web access: Use all_websites (use with caution)

Accommodations vs Resources

  • Don't use resources for accommodations - ProctorU will introduce a separate accommodations API
  • Resources are for exam materials only - These parameters specify what materials are allowed, not accessibility accommodations

Proctor Notes

Use the existing notes parameter for proctor-specific information such as:

  • Login credentials needed for exam access
  • Multi-authentication procedures
  • Troubleshooting steps for specific exam platforms

Test Taker Experience

Pre-Exam Review

Test takers can review their exam rules before starting by:

  1. Navigating to the "My Sessions" page
  2. Clicking "Check your exam rules"
  3. Reviewing the "Exam Rule Check" interface

During Pre-Checks

The permitted resources are displayed during the new pre-checks process, allowing test takers to confirm they have the necessary materials before beginning their exam.

Implementation Timeline

Release Date: April 2021

Preparation Steps:

  1. Contact your Account Manager to access the demo environment
  2. Test the new parameters before production release
  3. Update your integration code as needed

Backward Compatibility: The new parameters will be ignored if used before the official release, allowing you to deploy changes ahead of ProctorU's update.

Updating Exam Resources

To modify the allowed resources for an existing exam:

  • Use the editTermExam endpoint with the new resource parameters
  • The update will overwrite previous resource settings (not append)
  • Ensure you include all desired resources in the new request

Troubleshooting

No Resources Specified

If you don't use the new parameters, test takers will see default text indicating that the proctor will confirm allowed resources during the session.

Resource Not Available

If you need to allow a resource that isn't in the predefined list:

  1. Use the closest predefined option if applicable
  2. Add details in the other_resources field
  3. Consider requesting the resource be added to the official list

Support

For additional assistance with implementing these API changes:

  • Contact your ProctorU Account Manager
  • Test in the demo environment before production deployment
  • Review the complete API documentation for parameter details

This feature enhances exam security and clarity by ensuring both test takers and proctors have clear expectations about permitted materials before the exam begins.