Administrator Knowledge Base

Integrations & APIs

Exam Results

Certiverse Exam Result Model

Certiverse Exam Result Model

ExamResult (ContentType: application/json)

Contains the exam result information for a Candidate. 

Name	Schema
examDelivery required	Delivery
examReservation required	Reservation
candidate required	Candidate
exam required	Exam
examResult required	Result
testParts required	TestPartOutcome[]
rootTopicOutcomes required	RootTopicOutcome[]
customData optional	CustomData[]

Delivery

Name	Description	Schema
deliverableId required	Unique identifier for the exam delivery in the Certiverse test driver.	String
deliveryDateTime required	Delivery date-time in UTC. This is the actual date-time exam was started.	DateTime
deliveryCompletedDateTime required	The date-time in UTC the exam delivery was completed.	DateTime
bookingId required	Unique identifier for exam reservation from the system that provisioned the exam delivery.	String
eligibilityId optional	Optional unique identifier for exam eligibility from the system that provisioned the exam delivery.	String
deliveryType required	The delivery type used for the exam delivery. Provisioned AI Proctored - Secure Browser Live Proctored - Without Secure Broswer Live Proctored - Secure Browser Unproctored - Secure Broswer Unproctored	String
status required	Status of the exam delivery, which currently will always be “completed”	String
completeReasonCode  required	How the exam was completed. proctor ended candidate ended auto ended	String
terminationReason optional	List is configurable, but common termination reasons are. CandidateIntegrity CandidateLeft ProhibitedItem TestTakerTechnicalIssues Other: {proctor entered text}	String
deliveryExceptions required		DeliveryExceptions

DeliveryExceptions

Name	Description		Schema
timeExtension required	Was there a time extension for the exam delivery.	Bool

Reservation

Name	Description	Schema
storeExamSku optional	Exam sku/code configured in the Certiverse exam store. Only available for exams booked using exam store, not third party provisioning.	String
reservationDateTime  optional	If exam booking was scheduled, DateTime UTC it was scheduled for.	DateTime
candidateReservationDateTime  optional	If exam booking was scheduled, DateTime it was scheduled to be taken with the time zone it was scheduled for. Live proctored is time zone selected by candidate. Test Center is the test center time zone,	DateTimeOffset
paymentType optional	Payment type used if payment required to book exam. CreditCard Voucher	String
voucherId optional	Voucher Id used to book exam, if payment type was voucher.	String
promoCode optional	Promo code used to book exam, if payment type was credit card and a promo code was used.	String

Candidate

Name	Description	Schema
candidateId required	Unique identifier for candidate generated by Certiverse system.	String
orgCandidateId	Candidate Id assigned by the organization. Depending on configuration it can be passed by SSO, included in eligibility data, or entered by candidate.	String
firstName required	Candidate first name.	String
lastName required	Candidate last name.	String
email required	Candidate email.	String

Exam

Name 

Description 

Schema 

examName required

Exam name configured in the Certiverse authoring platform.

String

examCode required

Exam code configured in the Certiverse authoring platform.

String

examFormName 

required

Exam name configured in the Certiverse authoring platform.

String

examFormId required

Exam form GUID generated in the Certiverse authoring platform.

String

languageCode required

The exam language code for the exam delivery

Code	Language
de	German
en	English
es	Spanish
fr	French
ja	Japanese
zh-hans	Simplified Chinese
zh-hant	Traditional Chinese

String

languageName required

The name of the language for the exam delivery

String

Result

Name	Description	Schema
passFail optional	The pass or fail stats for the exam delivery. Determined by the cut score (mastery) settings for an exam form.	String
reportedScore optional	The candidate score value compared to the cut score which determines pass/fail.	Decimal
cutScore optional	The cut score (Mastery Level) set for the exam form used to determine pass/fail.	Decimal
cutScoreType optional	The type of cut score used to determine pass/fail. Values - Scaled - Percent - Raw TestPartScoring	String
maxRawScore required	The maximum number of correct scored items on the exam form.	Decimal
rawScore required	The number of correct scored items on the exam form.	Decimal
percent required	The percentage correct of scored items on the exam.	Decimal
scaled optional	The scaled score for the exam if it was configured for the Exam Form in Exam Management.	Decimal
timeOnExam required	Time spent on the exam in minutes.	Decimal
maxTimeOnExam  required	The maximum time allowed on an exam. Will include additional time if added through time extension.	Decimal
isRescore	Was this exam result created by the rescore process. Rescores can be done for Beta exams once the exam forms and cut scores are determined; or to correct scoring issues. The original scoring may not have been sent depending on the configuration of results processing.	Bool

TestPartOutcome

Name	Description	Schema
testPartName required	Name of the test part	String
passFail optional	The pass or fail status for the test part. Determined by the cut score settings for the test part. Not included if the test part outcome is set to none.	String
reportedScore optional	The test part score value which was used to determine pass/fail. Not included if test part cut score type set to none.	String
cutScore optional	The cut score set for the test part used to determine pass/fail. Not included if test part cut score type set to none.	String
cutScoreType optional	The type of cut score used to determine pass/fail for the test part. Not included if test part cut score type set to none. Values Percent Raw	String
maxScore required	The maximum number of correct scored items on the test part.	Decimal
rawScore required	The number of correct scored items on test part.	Decimal
percent required	The percentage correct of scored items on the test part.	Decimal
rootSections required	Results for all sections within the test part.	SectionOutcome[]

SectionOutcome

Name	Description	Schema
sectionName required	The section name as configured on the exam form.	String
maxScore required	The maximum number of correctly scored items in the section.	Decimal
rawScore required	The number of correctly scored items in the section.	Decimal
percent required	The percentage correct of scored items in the section.	Decimal
robustPercent required	The average of the percent correct for the section and the test part.	Decimal
outcomeBandName optional	The outcome band for the section, if outcome bads were configured.	String
items required	Result data for all items within the section.	ItemOutcome[]

ItemOutcome

Name	Description	Schema
itemName required	The item name assigned in the Certiverse authoring platform.	String
pretest required	Was the item presented as a pretest item. Pretest items are not included in max raw, raw, percent, or robust percent score calculations.	Bool
score required	Score for the item. Currently, a correct item is 1 and an incorrect item is 0.	Decimal
itemType required	The item type for the item. MC4 = Multiple Choice, 4 options MCR5-2 = Multiple Correct Response, 5 options, and 2 correct responses.	String
responses	Response ID for the response option(s) selected by candidate.  Response ID is permanently assigned to each response option when it is created and starts with 1 and increments for each response option when the item is created. Response options will be in an array Multiple Choice will have single Response ID Multiple Correct Response will contain list of all selected Response ID’s	Int[]
correctResponses required	Response ID for the correct response option(s) configured for the item. Response ID is permanently assigned to each response option when it is created and starts with 1 and increments for each response option when the item is created. Response options will be in an array Multiple Choice will have single Response ID Multiple Correct Response will contain list of all correct Response ID’s	Int[]
orderPresented required	The order the item was presented on the exam.	Int
time required	Time spent in seconds on the item.	Decimal
attempts required	Number of times a candidate attempted item during test delivery.	Int
notReached required	Was the item reached by the candidate during test delivery. True = Not seen by the candidate False = Seen by the candidate	Bool
rootTopicId required	The display ID for the root (highest level) topic in the blueprint to which the item is assigned.   Example: 1	String
topicId required	The display ID for the topic in the blueprint to which the item is assigned.   Example: 1.1.2	String
topicPath required	The full topic path from, root to lowest level topic, assigned to which the item is assigned.   Example: Root Topic 1>Child Topic 1>Grandchild Topic 1	String

RootTopicOutcome

Name	Description	Schema
topicId required	The display ID for the root (highest level) topic in the blueprint.	String
topicName required	The name of the root topic in the blueprint.	String
maxScore required	The maximum number of correct scored items in the root topic.	Decimal
rawScore required	The number of correct scored items in the root topic.	Decimal
percent required	The percentage correct of scored items in the root topic.	Decimal
robustPercent required	The average of the percent correct for the root topic and the exam.	Decimal

CustomData

Name	Description	Schema
name required	Name of the custom data field collected during exam booking.	String
value required	Value for the custom data field entered by candidate when booking the exam. Value can be null.	String

CustomData Format

"customData": [
  {
    "name": "name of the custom data field",
    "value": "value"
  }
]