Web service end point to update assessment results for PSI client(aka PSI account) and client provided eligibility code.

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 {account_code} value provided by PSI system. Account code represents a alphanumeric unique code for customer account in PSI system
  2. The caller must have a valid {eligibility_code} value provided by PSI system. eligibility_code is alphanumeric unique code for an eligibility under this customer account
  3. The caller must present a valid oAuth token obtained from PSI token service in the header field(s)

Request

PUT https:///accounts/{account_code}/{eligibility_code}/results

Path parameters

Parameter name Value Description Additional
account_code string

Global account code as specified in Atlas

Required
eligibility_code string

Client eligibility code

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.

Possible values are:

  • PASS
  • FAIL
Optional
score string

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

Optional

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 client eligibility id 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

account_code

Global account code as specified in Atlas

eligibility_code

Client eligibility code

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!