This is a special endpoint designed for RPNow test driver only. It accepts Assessment results using Atlas registration details

Request

POST https:///registrations/registration/results

Request body

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

{
    "desktopComments": [
        {
            "comments": "string",
            "duration": "integer",
            "eventFinish": "integer",
            "eventStart": "integer",
            "eventStatus": "string"
        }
    ],
    "examApiData": {
        "duration": "integer",
        "examCode": "string",
        "examName": "string",
        "examPassword": "string",
        "examSponsor": "string",
        "examUrl": "string",
        "orgExtra": {
            "examEndDate": "string",
            "examStartDate": "string",
            "noOfStudents": "integer"
        },
        "organization": "string",
        "reviewedExam": "boolean",
        "reviewerNotes": "string",
        "ssiProduct": "string"
    },
    "examDate": "string",
    "examMetaData": {
        "examCode": "string",
        "examName": "string",
        "examSponsor": "string",
        "organization": "string",
        "reviewedExam": "boolean",
        "reviewerNotes": "string",
        "simulatedExam": "boolean",
        "ssiExamToken": "string",
        "ssiProduct": "string",
        "ssiRecordLocator": "string"
    },
    "examProcessingStatus": "string",
    "examTakerEmail": "string",
    "examTakerFirstName": "string",
    "examTakerLastName": "string",
    "keySetVersion": "string",
    "overAllComments": "string",
    "reviewStatus": "string",
    "userPhotoBase64String": "string",
    "videoReviewLink": "string",
    "webCamComments": [
        {
            "comments": "string",
            "duration": "integer",
            "eventFinish": "integer",
            "eventStart": "integer",
            "eventStatus": "string"
        }
    ]
}

Properties

Name Type Description Additional
desktopComments[] array Optional
desktopComments[].comments string Optional
desktopComments[].duration integer Optional
desktopComments[].eventFinish integer Optional
desktopComments[].eventStart integer Optional
desktopComments[].eventStatus string Optional
examApiData object Exam Api Data Optional
examApiData.duration integer Optional
examApiData.examCode string Optional
examApiData.examName string Optional
examApiData.examPassword string Optional
examApiData.examSponsor string Optional
examApiData.examUrl string Optional
examApiData.orgExtra object Org Extra Optional
examApiData.orgExtra.examEndDate string Optional
examApiData.orgExtra.examStartDate string Optional
examApiData.orgExtra.noOfStudents integer Optional
examApiData.organization string Optional
examApiData.reviewedExam boolean Optional
examApiData.reviewerNotes string Optional
examApiData.ssiProduct string Optional
examDate string Optional
examMetaData object Exam Meta Data Optional
examMetaData.examCode string Optional
examMetaData.examName string Optional
examMetaData.examSponsor string Optional
examMetaData.organization string Optional
examMetaData.reviewedExam boolean Optional
examMetaData.reviewerNotes string Optional
examMetaData.simulatedExam boolean Optional
examMetaData.ssiExamToken string Optional
examMetaData.ssiProduct string Optional
examMetaData.ssiRecordLocator string Optional
examProcessingStatus string Optional
examTakerEmail string Optional
examTakerFirstName string Optional
examTakerLastName string Optional
keySetVersion string Optional
overAllComments string Optional
reviewStatus string Optional
userPhotoBase64String string Optional
videoReviewLink string Optional
webCamComments[] array Optional
webCamComments[].comments string Optional
webCamComments[].duration integer Optional
webCamComments[].eventFinish integer Optional
webCamComments[].eventStart integer Optional
webCamComments[].eventStatus 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 registration record).

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

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!