CaPPr Administrator API

This document describes how to use the CaPPr Administrator API. For general information about how to use the API, please consult the general API documentation.

Account

Get account information.

Method

GET

URL

/account

Example request

curl
    -H "Content-Type: multipart/form-data"
    -H "Authorization: Basic ZnJlZDpmcmVk"
    -X GET https://api.cappr.org/account

Response codes

Response properties

title (string)

Account title.

language (string)

Account language.

email (boolean)

false for Administrator accounts.

password (boolean)

false for Administrator accounts.

subject (boolean)

false for Administrator accounts.

position (boolean)

false for Administrator accounts.

test (boolean)

false for Administrator accounts.

report (string)

null for Administrator accounts.

set (object)

null for Administrator accounts.

positions (array)

null for Administrator accounts.

Example responses

200

{
    "title": "Account",
    "language": "en",
    "email": true,
    "password": false,
    "subject": false,
    "position": false,
    "test": false,
    "report": null,
    "set": null,
    "positions": null
}

Calculate

Calculate overall match score.

Method

GET

URL

/calculate/?personality=:personality&motivation=:motivation&iq=:iq

URL parameters

personality (int, required)

Big5 match score (min. 0, max. 100).

drives (float, required)

Drives match score (min. 0, max. 100).

iq (float, required)

IQ match score (min. 0, max. 100).

Example request

curl
    -H "Content-Type: multipart/form-data"
    -H "Authorization: Basic ZnJlZDpmcmVk"
    -X GET https://api.cappr.org/calculate?personality=100&motivation=100&iq=100

Response codes

Response properties

input (object)

Request input scores.

score (int)

Calculated overall score (min. 0, max. 100).

Example responses

200

{
    "input": {
        "personality": 100,
        "motivation": 100,
        "iq": 100
    },
    "score": 100
}