Paperscorer Core API Help

The Paperscorer Core API enables institutions to include advanced printing and scanning capabilities into their platforms.  Core API functionality can be found at the following link.  

Authentication

Regardless of the Paperscorer process, the first step is to provide authentication as an API partner (oAuthoToken) and then to login to Paperscorer on behalf of the educator who is using your system (userLogin).  If this is the first time that the educator has been logged into Paperscorer, we will create a new account.  After login, session information will be returned by Paperscorer, which can then be used in subsequent calls to the Paperscorer API. 

Endpoints Used The following workflow describes the authentication process.

Creating an Answer Sheet

 The first step in the Paperscorer process is for an educator to create answer ("bubble") sheets, based on a given assessment, for their students.  When this endpoint is called, Paperscorer dynamically generates the answer sheets based on the json data provided.  A unique URL is returned by the endpoints to a PDF file, which can be printed and distributed to students.  Students can fill these answer sheets out using pen or pencil.

Endpoints used  The following workflow describes this process.

Scanning Answer Sheets for Scoring

There are three ways that educators can send their scanned answer sheets to Paperscorer for scoring.  
  • Using the Paperscorer Mobile App - Responses are automatically sent to the Paperscorer services for scoring.  No integration effort required.
  • Scanning and Emailing - Responses are automatically sent to the Paperscorer services for scoring.  No integration effort required.
  • Scanning and Uploading - A means to upload scanned sheets must be added to your platform.
You will need to create a means up uploading PDF files to your platform so that the files can be sent to Paperscorer's web services.  Note that a single PDF file can contain answer sheets for multiple assessments and multiple students.  Once you receive a PDF file, it should be uploaded to submitAnswerSheetProcessingJob.  This endpoint creates a Job ID and begins processing the answer sheet using multiple threads/servers.  You can then periodically call the getProcessedFormIDs endpoint to determine which forms have been successfully processed in the job.

Endpoints Used The following workflow describes this process.

Retrieving Scores for Students

To return detailed results for each student related to a processed form, call the getScoresbyFormID endpoint.  This endpoint returns detailed results for each student answer sheet successfully processed by Paperscorer.  After receiving student responses and syncing the responses with your platform, it is important for your to call the acknowledgeSyncScore endpoint. This endpoint removes the student's results from subsequent responses.

Endpoints Used ​The following workflow describes this process.