Get Assessment

Retrieves assessment by id

GET /api/v1/assessments/{id}

Try it

cURL

cURL

curl --request GET \
  --url https://app.aegister.com/api/v1/assessments/{id} \
  --header 'X-Aegister-Token: <api-key>'

200

{
  "error": 0,
  "messages": "<array>",
  "data": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "score": 123,
    "name": {
      "en": "<string>",
      "it": "<string>"
    },
    "description": {
      "en": "<string>",
      "it": "<string>"
    }
  }
}

Authorizations

X-Aegister-Token · string · header · required

Path Parameters

id · integer · required

Response

200

application/json

error · integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0

messages · array

If error is 1, contains zero or more details on the error.

data · object

Show child attributes

data. id · number

Unique identifier for the Assessment.

data. created_at · string<date-time>

Timestamp of creation of the interview.

data. score · number

Interview score.

data. name · object

Assessment name

Show child attributes

data.name. en · string

Assessment name in English.

data.name. it · string

Assessment name in Italian.

data. description · object

Assessment description

Show child attributes

data.description. en · string

Assessment description in English.

data.description. it · string

Assessment description in Italian.