Get Started

                    

                        
Version: 0.0.1

                        
Last Updated: 2022-04-15

Lorem ipsum dolor sit amet consectetur adipisicing elit. Sequi delectus unde fuga hic dolorum, molestias totam? Recusandae tempora voluptatem optio molestiae modi odit reiciendis, dolores, blanditiis ab ea numquam officiis!

Revision history:

Version Date Revised By Approved By Reason of change
0.1 December 1, 2021 Initial Draft
-

List of Acronyms

Acronym Description
Super Admin Mundrisoft 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.

List of Stakeholders

Acronym Description
UUID Universal Unique Identifier

Application login management

With this feature user will be able to login to the application with the correct credentials.

Login

This API is used to login to the system

                                
JSON request

                                    
                                    
{

  "emailId": "string",

  "password": "string"

}

Method : POST

URL : <HOSTNAME>/login

PARAMETERS

Name Description Data Type
subDomainName * Sub domain name string

RESPONSES

Code Description
200 OK
{
"body": {},
"statusCode": "100 CONTINUE",
"statusCodeValue": 0
}
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

Refresh

This API is used to refresh the expired token.

Method : GET

URL : <HOSTNAME>/refresh

PARAMETERS

Name Description Data Type
token * Session generated token available post login string

RESPONSES

Code Description
200 OK
{
"data": {
"firstName": "string",
"lastName": "string",
"clientId": 0,
"clientuuId": "string",
"emailId": "string",
"roleDetails": {
"privileges": [
"string",
]
},
"accessToken": "string",
"userId": 0
},
"message": "Successfully Login",
"status": "success"
}
401 Unauthorized
403 Forbidden
404 Not Found

User management

This feature is used to create and manage client users. Client users would be able to create and manage Items, Tests, Schedules, Tags, accessing Reports, Users, Examinees Collections.

Mundrisoft/Clients

QA Client Registration by Mundrisoft 

                                
JSON request

                                    
                                    
{

"clientName": "string",

"clientUrl": "string",

"emailId": "string",

"firstName": "string",

"lastName": "string",

"password": "string",

"phone": "string",

"subDomainName": "string",

"timezonename": "string”

}

Method : POST

URL : <HOSTNAME>/mundrisoft/clients

RESPONSES

Code Description
200 OK
{
"success": boolean,
"message": "string",
"data": {
"message": "Success",
"status": "200"
},
"error": []
}
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

User Details/UseruuId

This API is invoked to get all the details of the user.

Method : GET

URL : <HOSTNAME>/userdetails/useruuId

PARAMETERS

Name Description Data Type
useruuId * User test UUID string

RESPONSES

Code Description
200 OK
{
"success": boolean,
"message": "string",
"data": {
"userid": 0,
"firstName": "string",
"lastName": "string",
"emailId": "string",
"phone": "string",
"active": boolean,
"modifiedDateTime": "2022-04-21T07:55:43",
"clientId": 0,
"modifiedByUser": "string",
"useruuId": "string",
"modifiedUserId": 0
},
"error": []
}
401 Unauthorized
403 Forbidden
404 Not Found

Users

This API is invoked to get the list of all the users for a selected client.

                                
JSON request

                                    
                                    
{

   "active": boolean,

   "clientId": 0,

   "emailId": "string",

   "firstName": "string",

   "lastName": "string",

   "password": "string",

   "phone": "string"

}

Method : GET

URL : <HOSTNAME>/users

PARAMETERS

Name Description Data Type
active * Status of the user boolean
emailid * User email address string
firstName * User’s first name string
lastName * User’s last name string

RESPONSES

Code Description
200 OK
{
"success": boolean,
"message": "string",
"data": [
{
"userid": 0,
"firstName": "string",
"lastName": "string",
"emailId": "string",
"phone": "string",
"active": boolean,
"modifiedDateTime": "2022-06-20T09:35:38",
"clientId": 0,
"modifiedByUser": "string",
"useruuId": "string",
"modifiedUserId": 0
},
],
"error": []
}
401 Unauthorized
403 Forbidden
404 Not Found

Users/collectionuuId

This API gets all users associated with the client excluding those already assigned to the collection.

Method : GET

URL : <HOSTNAME>/users/collectionuuId

PARAMETERS

Name Description Data Type
collectionuuId * Collection UUID string
Keyword * Search parameter for searching a user based on the keyword passed. Keyword can be either First name or Last name or an Email string

RESPONSES

Code Description
200 OK
[
{
"active": boolean,
"clientId": 0,
"emailId": "string",
"firstName": "string",
"lastName": "string",
"modifiedByUser": "string",
"modifiedDateTime": "2021-12-02T12:32:03.020Z",
"modifiedUserId": 0,
"phone": "string",
"userid": 0,
"useruuId": "string"
}
]
401 Unauthorized
403 Forbidden
404 Not Found

Users/userId/roles

This API is invoked to get roles and the associated collections for the user.

Method : GET

URL : <HOSTNAME>/users/userId/roles

PARAMETERS

Name Description Data Type
userId * User test ID integer (int64)

RESPONSES

Code Description
200 OK
{
"success": boolean,
"message": "string",
"data": {
"roles": [
"string",
],
"collections": [
0,
]
},
"error": []
}
401 Unauthorized
403 Forbidden
404 Not Found

Users/useruuId

This API is used to update the user details.

                                
JSON request

                                    
                                    
{

   "active": boolean,

   "firstName": "string",

   "lastName": "string",

   "phone": "string"

}

Method : PUT

URL : <HOSTNAME>/users/useruuId

PARAMETERS

Name Description Data Type
useruuId * User UUID string

RESPONSES

Code Description
200 OK



{
"success": boolean,
"message": "string",
"data": {
"userid": 0,
"firstName": "string",
"lastName": "string",
"emailId": "string",
"phone": "string",
"active": boolean,
"modifiedDateTime": "2022-06-22T10:21:11",
"clientId": 0,
"modifiedByUser": "string",
"useruuId": "string",
"modifiedUserId": 0
},
"error": []
}
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

Users/change-password

The API is invoked to change the password of the user. Users will be able to change the password by entering the new password.

                                
JSON request

                                    
                                    
 {

   "confirmPassword": "string",

   "newPassword": "string",

   "oldPassword": "string"

}

Method : POST

URL : <HOSTNAME>/change-password

RESPONSES

Code Description
200 OK
{
"success": boolean,
"message": "string",
"data": {
"userid": 0,
"firstName": "string",
"lastName": "string",
"emailId": "string",
"phone": "string",
"active": boolean,
"modifiedDateTime": "2022-06-21T08:01:36",
"clientId": 0,
"modifiedByUser": null,
"useruuId": "string",
"modifiedUserId": 0
},
"error": []
}
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

Users/reset-password

This API is invoked to reset password of a user. The reset password is mailed to the user.

                                
JSON request

                                    
                                    
{

   "emailId": "string"

}

Method : POST

URL : <HOSTNAME>/reset-password

PARAMETERS

Name Description Data Type
subDomainName * Subdomain name string

RESPONSES

Code Description
200 OK
{
"success": boolean,
"message": "string",
"data": {
"message": "string",
"status": "200"
},
"error": []
}
201 Created
401 Unauthorized
403 Forbidden
404 Not Found