Results Request API

Results Request API

Certiverse Results Request API Overview

The Certiverse Results Request API allows organizations to request results from an endpoint hosted in the Certiverse platform. Results can be returned using either results processing or results search.

• Results Processing: Request all results not previously processed, meaning not returned using this call.
• Results Search: Request results using criteria, which will return results, regardless of the processed status and will not mark the results as processed.

Certiverse Results Request Processing

The results request GET call will determine if Results Processing or a Results Search is performed.

• Results Processing: GET call without any criteria will return results for the Organization that have not been previously requested and processed using this call.
• The response will include the data property with up to 100 results in an array; and the nextLink property which will include a link to get the next set of results, or if all the results available have been returned null.

Certiverse Results Request Search

The GET call with any criteria is used to request results for the Organization, regardless of the results processing status. Results returned by the search will not be marked as processed. The response will include the data property with up to 100 results in an array; and the nextLink property which will include a link to get the next set of results, or if all the results available have been returned null.

Certiverse Results Request Search Criteria

Certiverse Results Request Search supports only one search criteria at a time, which is passed as a query string parameter.

Query String Parameter Options

• EligibilityId o Parameter: eligibilityId
  • The eligibility Id associated with the exam result if eligibility was used. For exam store bookings, if eligibility was used for the exam store booking, the eligibility Id provided to Certiverse will be stored with the exam result. If the exam was provisioned by an external system, the eligibility Id can be passed in the exam provisioning.
• Organization CandidateId o Parameter: candidateId
  • The candidate Id assigned by the organization to identify a candidate. If the exam was provisioned by an external system the Organization Candidate Id can be passed in the exam provisioning. The Organization Candidate Id search criteria is not currently supported for exam booking created in from the exam store.
• Organization BookingId o Parameter: bookingCode
  • This is a unique identifier for the exam that can be generated and passed to Certiverse by the external system that provisions the exam.
• Certiverse CandidateId o Parameter: certiverseCandidateId
  • The unique candidate Id generated by Certiverse. (example: C3-539)
• Certiverse BookingId o Parameter: certiverseBookingCode
  • This is the Certiverse internal booking id for reservations (example: 4016AD)

          

Certiverse Eligibility API Version Information

Version: 1.0

URI Scheme

Base Path: api/exam/results

Scheme: HTTPS

Paths Summary

Authenticate as a Certiverse partner to gain an authentication token for calls needing to be executed

GET /authenticate

Headers

Query Parameters

Parameter	Description	Type
Code	Optional value to pass in that will be returned telling the caller API call has not been intercepted	string (optional)

Responses

Http StatusCode	Description	Schema
200	Return authentication token	PartnerDataTokensModel
400	Error if request is missing or invalid properties	ErrorModel
401	Error if credentials are incorrect	ErrorModel
500	Error if server errors	ErrorModel

Models

PartnerDataTokensModel (ContentType: application/json)

Property	Description	Type
authToken	Token for authorization on any other calls	string
code	Value provided in request returned	string

ErrorModel (ContentType: application/json)

Property	Description	Type
errorCode	Internal error code	string (optional)
errorMessages	List of error messages	string[]

Summary

Request results from an endpoint hosted in the Certiverse platform. Supports results processing and search by criteria. Results processing returns results not previously processed, and marks result as processed. Search by criteria returns results matching criteria and will not mark results as processed.

GET / exam/results

Headers

Key	Description	Value
authorization	Authorization Bearer token	Bearer <token from authenticate call>

Parameters

• Processing: No parameters
• Search: Exactly one query parameter per request

Type	Description	Parameter Name
Query string parameter		eligibilityId
Query string parameter	Organization Candidate Id	candidateId
Query string parameter	Externally generated booking code	bookingCode
Query string parameter	Certiverse Candidate Id	certiverseCandidateId
Query string parameter	Certiverse generated booking code	certiverseBookingCode

Responses

Http StatusCode	Description		Schema
200			RequestResultsModel []
	[]
400	Bad Request		ErrorModel
401	Error if credentials are incorrect		ErrorModel
500	Error if server errors		ErrorModel

Models

RequestResultsModel (ContentType: application/json)

Property	Description	Type
data	Contains up to100 exam results. Each exam result contains the available score information for the exam delivery, test parts, sections, items, and root topics. Desired information can be extracted.	ExamResult[]
nextLink	Link to next set of results, which can be up 100 results. Null or no property indicates no additional results.	Link

 

Contact Us

If you have any questions or need additional assistance, please contact us by either emailing support@certiverse.com or by submitting a ticket from this article.