# Sonality API Documentation Welcome to the Sonality API! This API allows you to integrate personality assessment functionalities into your applications. You can create, manage, and retrieve assessments to gain insights into individual personalities. ### Base URL https://sonality.runasp.net/ ### Endpoints #### Create Assessment Creates a new assessment. POST /api/assessments
Request Body
assessmentType (string, REQUIRED): Type of assessment (MyerBriggs, BigFive)
totalQuestions (int, REQUIRED): Number of questions (range: 30-100)
subscriptionUri (string, OPTIONAL): URL to send results upon completion

Example Request
``` { "assessmentType": "myerbriggs", "totalQuestions": 50, "subscriptionUri": "https://mycallback.com/assessments" } ```
#### Retrieve Assessment Gets details of a specific assessment.
GET /api/assessments/{id}

Path Parameter
id (string, REQUIRED): Assessment ID

Example Response ``` { "id": "e794bf90-9e69-4832-9acc-297641207115", "type": "Myer-Briggs Type Indicator", "initiated": "2024-06-12T20:17:26.1747361", "completed": "2024-06-12T20:44:07.6099232", "totalQuestions": 40, "status": "Completed", "personality": "ESTJ-A", "results": [ { "traitGroup": "Introversion/Extraversion", "traits": [ {"traitName": "Introversion", "percentage": 30, "acronym": "I"}, {"traitName": "Extraversion", "percentage": 70, "acronym": "E"} ] } ] } ``` #### Update Assessment
Submits answers for an assessment.
PATCH /api/assessments/{id}

Path Parameter
id (string, REQUIRED): Assessment ID

Request Body
answer (object, REQUIRED): List of question and answer IDs

Example Request
``` [ {"answerId": 1, "questionId": 29}, {"answerId": 2, "questionId": 4} ] ``` #### Retrieve Assessment Questions #### Gets questions for an assessment.
GET /api/questions

Query Parameters
assessmentId (string, REQUIRED): Assessment ID
pageNumber (int, OPTIONAL): Page number (default: 1)
pageSize (int, OPTIONAL): Page size (default: 10)

### Error Handling All endpoints return errors in the following format:
``` { "type": "string", "message": "string", "statusCode": 0, "extensions": { "additionalProp1": "string", "additionalProp2": "string" } } ``` For more details, visit the Sonality API Documentation at https://sonality.teleporthq.app/documentation. This README covers the basic usage of the Sonality API. For more detailed information, including the full list of endpoints and models, please refer to the official documentation.