Assessment results using booking Code

Web service end point to update results for a booking(aka Atlas schedule) using BookingCode. This is the most recommended endpoint to be used by external test drivers. Neither result nor score is revealed to candidate on the UCS candidate website.

API Authentication

HTTP requests to PSI REST APIs are protected with oAuth2 based authentication. To learn more about how PSI handles authentication, please refer to our authentication section

Prerequisites

  1. The caller must have a valid {booking_code} value provided by PSI system. Booking code represents a alphanumeric unique code for reservation in PSI system
  2. The caller must present a valid oAuth token obtained from PSI token service in the header field(s)

Request

PUT https:///bookings/{booking_code}/results

Path parameters

Parameter name Value Description Additional
booking_code string

Alphanumeric unique identifier for this exam appointment (aka appointment ID, confirmation ID)

 Required

Request body

The request body takes a complete Candidate Results Details resource, containing the following writable properties:

{
    "result": "string",
    "score": "string"
}

Properties

Name Type Description Additional
result string

What was the outcome of scoring. If you do not wish to provide results to PSI, you can provide NA as a test result but it must also be accompanied with a score value (any integer, for example, 0).

Possible values are:

  • PASS
  • FAIL
  • NA
score string

How much did the candidate score. The score can either be Integer or Real or AlphaNumeric.

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Expected response to a valid request
400 Bad Request

Error details in case of error situation (When a matching booking code data is not found in Atlas).

 error
500 Internal Server Error

Internal Server Error (When one or more components are down in Atlas system). In this case test driver is expected to retry to ensure guaranteed delivery.

 error

Explore this API

booking_code

Alphanumeric unique identifier for this exam appointment (aka appointment ID, confirmation ID)
Payload

Candidate result details
Request Content-Type
Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!