Introduction

List of Acronyms

Acronym Description
UUID Universal Unique Identifier

List of Stakeholders

Acronym Description
Super Admin Super admin who will have access to create new Clients.
Client user / User Users who would be accessing Tanay application. They will be creating and managing Items, Tests, Schedules, Tags, accessing Reports, Users, Examinees etc.
Examinee user / Examinee Users who would be appearing for an assigned test.

Test Login

Login (Public)

This API returns the access token for the examinee to login to public schedule. 

                                
JSON request

                                    
                                    
{

  "scheduleId": "string",

  "userJson": {

    "parameter one": "string",

    "parameter two": "string"

  }

} 

                                    
                                
                                
JSON Response

                                    
                                    
{

    "headers": {},

    "body": {

        "message": "Successfully Login",

        "status": "success",

        "data": {

            "accessToken": "string",

            "string": null,

            "string": null,

    "emailid": "string",

            "clientId": 0,

            "examineeId": 0

        }

    },

    "statusCode": "OK",

    "statusCodeValue": 200

}

Method : POST

URL : <HOSTNAME>/publiclogin

PARAMETERS

Name Description Data Type
subDomainName * string

RESPONSES

Code Description
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

Login (Private)

This API returns the type of schedule.

                                
JSON Response

                                    
                                    
{

    "scheduleType": "string"

}

Method : GET

URL : <HOSTNAME>/logincheck/scheduleuuid

PARAMETERS

Name Description Data Type
scheduleuuId * string

RESPONSES

Code Description
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

Test Schedule

Schedule Details

This API is invoked to fetch details of a schedule of the logged-in examinee.

                                
JSON Response

                                    
                                    
{

    "testId": 0,

    "testTitle": "string", 


    "testDescription": "string",

    "durationDisplay": "",

    "duration": 0,

    "userTestId": 0,

    "durationapplicable": boolean,

    "examCompleted": boolean, 


    "preTestMessage": {

        "mediaURL": [

            "String"

        ],

        "description": "string"

    },

    "scheduleStatus": "string",

    "scheduleName": "string",

    "scheduleuuId": "string",

    "scheduleDescription": "",

    "scheduleStartDate": "string",

    "scheduleEndDate": "string",

    "usertestuuId": "string",

    "testbankuuId": "string",

    "isScheduleStarted": boolean,

    "isScheduleExpired": boolean,

    "isAutoSubmitted": boolean

}

Method : GET

URL : <HOSTNAME>/test-delivery/schedule/scheduleuuid

PARAMETERS

Name Description Data Type
scheduleuuid * string

RESPONSES

Code Description
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

Test Details

Test Countdown

This API calculates the time consumed for the test.

                                
JSON Response

                                    
                                    
{

    "consumedTestTime": 0,

    "status": "200",

    "message": "success"

}

Method : GET

URL : <HOSTNAME>/test-delivery/users/userTestId/test-time/testid

PARAMETERS

Name Description Data Type
userTestId * User Test ID integer (int64)
userTestuuid * string

RESPONSES

Code Description
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

Item Details

This API is invoked to fetch the items in a test for the logged-in examinee 

                                
JSON Response

                                    
                                    
{

    "string": 0,

    "string": [

        {

            "itemId": 0,

            "displayOrder": 0,

            "itemBankName": "string",

            "totalQuestions": 0,

            "itemuuId": "string"

        },

    ]

}

Method : GET

URL : <HOSTNAME>/test-delivery/test/testuuid/items

PARAMETERS

Name Description Data Type
usertestuuId * string

RESPONSES

Code Description
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

Get Questions

This API is invoked to fetch the questions in an Item of a particular Test. 

                                
JSON Response

                                    
                                    
{

    "string": [

        {

            "questionuuId": "string",

            "shuffleOption": boolean,

            "ansRenderCount": 0,

            "displayOrder": 0,

            "questiondescription": {

                "mediaURL": [

                    "string"

                ],

                "description": "string",

            },

            "questionType": "string",

            "questionSubType": "string",

            "attempted": boolean,

            "options": [

                {

                    "optiId": 0,

                    "arrangeOrder": 0,

                    "answerDescription": {

                        "mediaURL": [

                            "string"

                        ],

                        "description": "string"

                    },

                    "selected": boolean,

                    "existingId": 0

                },

            ]

        },

    ]

}

Method : GET

URL : <HOSTNAME>/test-delivery/test/userTestuuId/items/itemuuId/questions

PARAMETERS

Name Description Data Type
itemuuId * Item ID string
userTestuuId * User test uuID string

RESPONSES

Code Description
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

Submit Test

This API is invoked to submit the test.

                                
JSON Response

                                    
                                    
{

    "totalCorrectAnswer": 0,

    "totalIncorrect": 0,

    "totalScore": 0,

    "totalAttempted": 0,

    "totalTestQuestions": 0,

    "unAttemptedQuestions": 0,

    "totalPositiveScore": 0,

    "totalNegativeScore": 0,

    "postTestMessage": {

        "mediaURL": [

            "String"

        ],

        "description": "string"

    },

    "submitStatus": boolean

}

Method : GET

URL : <HOSTNAME>/test-delivery/users/usertestuuId/submit-test

PARAMETERS

Name Description Data Type
usertestuuId * string
*

RESPONSES

Code Description
200 OK
401 Unauthorized
403 Forbidden
404 Not Found

Test Submission

Submit Answers

This API is invoked to submit test answers. 

                                
JSON request

                                    
                                    
{

  	"testuuId": "string",

 	 "userTestuuId": "string",

 	 "answers": [

    	{

     	 "string": "string",

      	 "string": [

        	 0,

      	 ]

    	},

  	]

}

Method : POST

URL : <HOSTNAME>/test-delivery/questions/answers

RESPONSES

Code Description
200 status: OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found