Assessment Metadata
About
This Awarathon API is used to get the list of assessments which are available for your company's domain. In this, you will get assessment details, mapped questions, mapped users and mapped managers. To access this API you will need to post two mandatory parameters playload and token.
Purpose
To get the list of assessments available for your company domain
Request URL
https://restapi.awarathon.com/api/get_assessment_metadata
ATTRIBUTES
| Attribute Name | Data Type | Description |
|---|---|---|
| count | Integer | Total count of assessments that you retrieve from the API |
| assessment_id | Integer | Id of assessment |
| assessment_name | Varchar | Assessment name |
| read_more | Long Text | Details of assessment |
| assessment_type | Integer | Type of assessment like 0,1,2 |
| assessment_type_name | Varchar | Type name of assessment like text,video,image |
| assessment_start_date | Datetime | Start date of assessment |
| assessment_end_date | Datetime | End date of assessment |
| instruction | Long Text | Description of assessment |
| attempts_allowed | Integer | Total attempt allowed to user |
| assessment_status | Varchar | Status of assessment like, live and expired |
| mapped_question | Array | Details of question which mapped with assessment |
| mapped_users | Array | Details of user which mapped with assessment |
| mapped_manager | Array | Details of manager which mapped with assessment |
| success | Boolean | Type of api status like true,false |
| message | Varchar | Message for api status |
QUERY PARAMS
This API fetches the details of Assessment from your help desk.
| Param Name | Data Type | Description |
|---|---|---|
| payload | varchar, mandatory |
Payload is used for authentication, which is retrieved from the Get Credential API. |
| token | varchar, mandatory |
Token is used for authentication, which is retrieved from the Get Credential API. |
| from_date | date, formate -: dd-mm-yyyy |
From date is used for from which date you have to retrieve assessment |
| to_date | date, formate -: dd-mm-yyyy |
To date is used for till which date you have to retrieve assessment |
Endpoints
restapi.awarathon.com/api/get_assessment_metadata
Example
Postdata
$post_array = array(
'payload'=>"eyJ0eXAiOiJqd3QiLxxxxxxxxxxxxxxxxxxxxTEh24ARl_u_uLyQA6M",
'token_no'=>"92.bb98eca7xxxxxxxx",
'from_date'=>"dd-mm-yyyy",
'to_date'=>"dd-mm-yyyy"
);
$curl = curl_init();
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($post_array));
curl_setopt($curl, CURLOPT_URL, 'https://restapi.awarathon.com/api/get_assessment_metadata');
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$result = curl_exec($curl);
Response
"count": 2,
"data": [
{
"assessment_id": "1",
"assessment_name": "Awarathon Skill Assessment",
"read_more": "
Dear User,
\r\n\r\nWe will be simulating a real-world situation, and a series of questions will be shot at you.
\r\n\r\n(1) Make sure you hold the phone close so assessors can hear clearly;;
\r\n\r\n(2) Speak clearly
\r\n","assessment_type": "2",
"assessment_type_name": "VIDEO",
"assessment_start_date": "24-08-2022 17:00:00",
"assessment_end_date": "31-08-2022 18:00:00",
"instruction": "
(1) Make sure you hold the phone close so assessors can hear clearly;
\r\n\r\n(2) Speak clearly
\r\n\r\n(3)Hold the phone properly so that you are clearly visible;
\r\n\r\n(4) There are a number of allowed attempts. Do not submit the video unless you are sure this is your best attempt.
\r\n\r\nBest of luck. You are going live now!
\r\n\r\nPress begin when you are ready.
\r\n","attempts_allowed": "10",
"total_question": 2,
"assessment_status": "Expired",
"mapped_question": [
{
"question_id": "1",
"question": "What will be your response if the client says \"I like it but I am not sure if I want to buy the policy now?",
"format": "0",
"format_name": "Text"
},
{
"question_id": "2",
"question": "What will be your approach to resolve Ramesh#39;s concern & how will you manage him when he is persistent to cancel the Insurance?\r\n\r\n
this is title for Test
\r\n\r\nfor test
","format": "0",
"format_name": "Text"
}
],
"mapped_users": [
{
"user_id": "7905",
"full_name": "Test 1",
"user_name": "121",
"email": [email protected]",
"manager_user_id": "320",
"manager_username": "13",
"manager_fullname": "Manager 1",
"manager_email": "[email protected]"
}
],
"mapped_manager": [
{
"user_id": "320",
"user_name": "13",
"full_name": "Manager 1",
"email": "[email protected]"
}
]
}
],
"success": true,
"message": "Assessment data loaded successfully."
}
Assessment Process Data
About
This Awarathon API is used to get a list of assessments available for your company domain, you will get the assessment details and you can map users with details like user name,employee code, user attempt,last attempt date, assessment completed date, user status completed or incopleted, etc. To assess this API, two mandatory parameters need to be posted, like the payload and token.
Purpose
To get the list of assessments available for your company domain
Request URL
https://restapi.awarathon.com/api/get_assessment_proccess_data
ATTRIBUTES
| Attribute Name | Data Type | Description |
|---|---|---|
| count | Integer | Total count of assessments that you retrieve from the API |
| assessment_id | Integer | Id of assessment |
| assessment_name | Varchar | Assessment name |
| assessment_type | Integer | Type of assessment like 0,1,2 |
| assessment_type_name | Varchar | Type name of assessment like text,video,image |
| assessment_start_date | Datetime | Start date of assessment |
| assessment_end_date | Datetime | End date of assessment |
| total_question | Integer | Count of total question mapped |
| attempts_allowed | Integer | Total attempt allowed to user |
| assessment_status | Varchar | Status of assessment like, live and expired |
| user_id | Integer | Id of user which mapped with assessment |
| username | Varchar | Name of user which mapped with assessment |
| emp_code | Varchar | Employee code of user which mapped with assessment |
| user_status | Varchar | Status of user played or not like completed and incomplete |
| attempts | Integer | Attempts of user while play assessment |
| completed_date | Datetime | Assessment completed date of user |
| last_attempt_date | Datetime | Last attempts date of user |
| success | Boolean | Type of api status like true,false |
| message | Varchar | Message for api status |
QUERY PARAMS
This API fetches the details of Assessment from your help desk.
| Param Name | Data Type | Description |
|---|---|---|
| payload | varchar, mandatory |
Payload is used for authentication, which is retrieved from the Get Credential API. |
| token | varchar, mandatory |
Token is used for authentication, which is retrieved from the Get Credential API. |
| from_date | date, formate -: dd-mm-yyyy |
From date is used for from which date you have to retrieve assessment |
| to_date | date, formate -: dd-mm-yyyy |
To date is used for till which date you have to retrieve assessment |
Endpoints
restapi.awarathon.com/api/get_assessment_proccess_data
Example
Postdata
$post_array = array(
'payload'=>"eyJ0eXAiOiJqd3QiLxxxxxxxxxxxxxxxxxxxxTEh24ARl_u_uLyQA6M",
'token_no'=>"92.bb98eca7xxxxxxxx",
'from_date'=>"dd-mm-yyyy",
'to_date'=>"dd-mm-yyyy"
);
$curl = curl_init();
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($post_array));
curl_setopt($curl, CURLOPT_URL, 'https://restapi.awarathon.com/api/get_assessment_proccess_data');
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$result = curl_exec($curl);
Response
"count": 2,
"data": [
{
"assessment_id": "184",
"assessment_name": "Awarathon Skill Assessment",
"assessment_type_name": "VIDEO",
"assessment_start_date": "24-08-2022 17:00:00",
"assessment_end_date": "31-08-2022 18:00:00",
"attempts_allowed": "10",
"total_question": 2,
"assessment_status": "Expired",
"prossess_data": [
{
"user_id": "7905",
"username": "Nikita Karmarkar",
"emp_code": "121",
"email": "[email protected]",
"user_status": "Completed",
"attempts": "1",
"completed_date": "25-08-2022 12:14:04",
"last_attempt_date": "25-08-2022 12:11:23"
}, { "user_id": "7906",
"username": "Nikita Karmarkar",
"emp_code": "212",
"email": "[email protected]",
"user_status": "Completed",
"attempts": "1",
"completed_date": "25-08-2022 12:40:05",
"last_attempt_date": "25-08-2022 12:37:32"
},
{
"user_id": "7827",
"username": "Priyanka Phadke",
"emp_code": "D_4",
"email": "[email protected]",
"user_status": "Completed",
"attempts": "3",
"completed_date": "25-08-2022 13:02:04",
"last_attempt_date": "25-08-2022 12:59:22"
},
{
"user_id": "7852",
"username": "Priyanka Phadke",
"emp_code": "D_40",
"email": "[email protected]",
"user_status": "Incomplete",
"attempts": null,
"completed_date": "13-10-2022 10:20:09",
"last_attempt_date": "13-10-2022 10:20:09"
},
{
"user_id": "7862",
"username": "Priyanka Awarathon2",
"emp_code": "222",
"email": "[email protected]",
"user_status": "Incomplete",
"attempts": null,
"completed_date": "13-10-2022 10:20:09",
"last_attempt_date": "13-10-2022 10:20:09"
}
]
},
{
"assessment_id": "183",
"assessment_name": "Krishna test12",
"assessment_type_name": "VIDEO",
"assessment_start_date": "10-08-2022 17:00:00",
"assessment_end_date": "10-10-2022 22:00:00",
"attempts_allowed": "100",
"total_question": 3,
"assessment_status": "Expired",
"prossess_data": []
}
],
"success": true,
"message": "Assessment data loaded successfully."
}
