Certiverse Booking Notifications

This service allows organizations to track candidate activity and synchronize booking status and eligibility across all integrated systems. This will be available in the Store and configured per exam.

Booking Notification Triggers

Created

Rescheduled

Cancelled

Completed

NoShow

Scheduled booking candidate did not show up for

Unscheduled booking that was never started and expires

Type	Description	Schema
Body	Contains the exam booking information for a Candidate.	BookingNotification

Model

BookingNotification

Contains the booking information for a Candidate.

Name	Schema
booking required	Booking
candidate required	Candidate
exam required	Exam
examReservation optional	Result

Booking

Type	Description	Schema
systemBookingId		string
bookingId required	Unique identifier for exam reservation from the system that provisioned the exam delivery. Should be user facing alphanumeric reservation code.	string
previousBookingId		string
notificationType required	Created Rescheduled Cancelled Completed NoShow	string
notificationDateTime required	Date-time the update that triggered the notification occurred.	DateTime
deliveryType required	ScheduledLiveProctor ScheduledLiveProctorWithoutSEB PartnerAPI LiveProctor Unproctored UnproctoredSecureBrowser TestCenter	string
scheduledDateTime required	Date-Time the exam is scheduled to be taken. Unscheduled exams it will be the date-time the exam booking was created. Reschedule will have new date-time Scheduled should be in the time in zone they scheduled and include time zone Unscheduled should be in UTC	DateTime
scheduledIanaTimeZone		string
scheduledWindowsTimeZoneId		string

deliveryDateTime	Delivery date-time in UTC. This is the actual date-time exam was started. null if exam not started.	DateTime
eligibilityId	Optional unique identifier for exam eligibility from the system that provisioned the exam delivery.	string

Candidate

Type	Description	Schema
systemCandidateId		string
candidateId required	Unique identifier for candidate generated by Certiverse system. Should be user facing alphanumeric User Id.	string
clientCandidateId optional	Client Candidate Id assigned to booking. Business rules for assigning it to booking determine what Id is used.	string
firstName required	Candidate first name.	string
lastName required	Candidate last name.	string
email required	Candidate email.	string

Exam

Type	Description	Schema
examName required	Exam name configured in the Certiverse exam store.	string
examCode required	Exam code configured in the Certiverse exam store.	string
languageCode required	Language selected when booking the exam.	string
languageName required	Language selected when booking the exam.	string

ExamReservation (result)

Only included for ExamCompleted.

Type	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 that was compared to the cut score to 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 RawScore ScaledScore PercentScore TestPartScoring PbtProviderDetermined	string
completeReasonCode optional	How the exam was completed.  The actual values should be the same ones we use for results feed. ProctorCompleted  CandidateCompleted  ProctoringException  AgreementDeclined Abandoned	String
terminationReason optional	List is configurable, but common termination reasons are.  PersonInRoom, ProhibitedItem, CandidateLeft, TalkingAloud, ProhibitedApplications, CandidateIntegrity, SystemError, TestTakerTechnicalIssues, TestTakerNetworkIssues, Other	String