Assessment results from AtlasCloud test driver

This is a special endpoint designed for Atlas Cloud test driver only. It accepts Assessment results using account code and Candidate details.

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

Request

PUT https:///accounts/{account_code}

Path parameters

Parameter name Value Description Additional
account_code string

Global account code as specified in Atlas

 Required

Request body

The request body takes a complete candidate Result Data resource, containing the following writable properties:

{
    "candidate_id": "string",
    "category_scores": [
        {
            "category_name": "string",
            "category_order": "string",
            "category_score_pct": "string"
        }
    ],
    "category_total_count": "integer",
    "overall_score_label": "string",
    "overall_score_pct": "string",
    "overall_score_scaled": "integer",
    "result": "string",
    "result_id": "string"
}

Properties

Name Type Description Additional
candidate_id string Optional
category_scores[] array Optional
category_scores[].category_name string Optional
category_scores[].category_order string Optional
category_scores[].category_score_pct string Optional
category_total_count integer Optional
overall_score_label string Optional
overall_score_pct string Optional
overall_score_scaled integer Optional
result string Optional
result_id string 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 Atlas can not find a matching candidate exam under provided customer account).

 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
Payload

Candidate result data
Request Content-Type
Response Content-Type

Choose an authorisation method:

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