How to use APIs for Integration

Modified on Wed, 17 May, 2023 at 11:49 AM

Explore below APIs to integrate Eklavvya Assessment Platform with your system

API Documentation

1. Create Subject(Course) API

Description: To create new question firstly subject i.e. course should be created.

URL: http://splashwebapi.eklavvya.in/SplashService.svc/AddSubjectWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

This authentication key belongs to my personal institute on LIVE. When any client’s institute is created on Eklavvya LIVE site then this key will be changed. There will be separate authentication key for each client.

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	SubjectName	String	Yes	Subject for which questions will be added

Test case:

Subject name should be unique.

Output

Sr. No.	Name	Data Type	Description
1	SubjectID	Long	Created Subject ID
2	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
3	objStatusCodes	INT	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

2. Update Subject API

Description: This API is used to update particular Subject.

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ UpdateSubjectWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	SubejctID	Long	yes	Subject ID is for particular Subject
2	SubjectName	string	yes	Subject Name

Output

Sr. No.	Name	Data Type	Description
1	Subject ID	Long	It shows updated Subject ID
2	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
3	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

3. Get Subject API

Description: This API is used to get all subject. Which are present with in institute or you can get Subject while searching Subject name

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ GetSubjectListWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	InstituteID	Long	Either One of them is required	Institute ID for particular Institute
2	SubjectName	string	Subject Name is used for searching

Output

Sr. No.	Name	Data Type	Description
1	Subject ID	Long	It shows Subject ID
2	Subject Name	String	It show Subject Name
3	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
4	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

4. Deactivate Subject API

Description: This API is used to deactivate selected subject.

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ DeactivateSubjectWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	CategoryID	Long	yes	Category ID is for particular Subject
2	CategoryName	string	yes	Category Name (Subject Name)

Output

Sr. No.	Name	Data Type	Description
1	Category Name	string	It shows deleted Subject Name
2	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
3	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

5. Add topic API

Description: To Add Topic on particular Subject

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ AddTopicWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	Subject ID	int	Either One of them is required	Subject ID is unique Id for each subject so you can use either subject ID or Subject Name to add new topic.
2	Subject Name	string	Subject Name is used to add topic in particular subject using Subject Name we make sure that Topic is add under Specified Subject.
3	Topic Name	string	yes	Topic Name is used to add Topic under given Subject Name this is required to add a topic.

Output

Sr. No.	Name	Data Type	Description
1	Message	string	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
2	Object Status Code	int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	Topic ID	int	When New Topic add new Topic ID will be created.

6. Update topic API

Description: This API is used to update particular Topic.

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ UpdateTopicNameWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	TopicID	Long	yes	Topic ID is for particular Subject
2	TopicName	string	yes	Topic Name

Output

Sr. No.	Name	Data Type	Description
1	Topic ID	Long	It shows updated Topic ID
2	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
3	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

7. Get topic API

Description: This API is used to get all Topic. Which are present with in particular Subject

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ GetTopicListWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	SubjectID	Long	Either One of them is required	Subject ID for particular Subject
2	SubjectName	string	Subject Name is used for searching

Output

Sr. No.	Name	Data Type	Description
1	Topic ID	Long	It shows Topic ID
2	Topic Name	String	It show Topic Name
3	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
4	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

8. Create objective/subjective question API

Description: To add the objective/subjective question

URL: http://splashwebapi.eklavvya.in/SplashService.svc/AddQuestionWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	SubejctID	Long	Yes	Subject ID to identify the subject
2	SubjectName	string	Yes	Subject Name to identify the subject
3	TopicID	Long	Yes	Topic ID to identify the topic
4	TopicName	string	Yes	Topic Name to identify the topic
5	QuestionType	string	Yes	Question Type (MCQ , FILL IN BANKS, TRUE OR FALSE, MATCH THE PAIR , MULTISELECT, SUBJECTIVE )
6	DifficultyLevel	string	No	Difficulty Level (BASIC, EASY, MODERATE, HARD, DIFFICULT, Default: Basic)
7	Question	string	Yes	Question which on to added
8	Image	string	No	URL of Image for the question
9	Audio	string	No	URL of Audio for the question
10	Video	string	No	URL of Video for the question
11	Marks	int	Yes	Marks for the question
12	Option1	string	Yes	Option 1 for question
13	OptionImage1	string	No	URL of Image of Option 1 for question
14	IsOption1Correct	bit	Yes	Is Option1 is Correct for question
15	OptionMarks1	int	No	Marks of Option 1 for question
16	Option2	string	No	Option 2 for question
17	OptionImage2	string	No	URL of Image of Option 2 for question
18	IsOption2Correct	bit	No	Is Option2 is Correct for question
19	OptionMarks2	int	No	Marks of Option 2 for question
20	Option3	string	No	Option 3 for question
21	OptionImage3	string	No	URL of Image of Option 3 for question
22	IsOption3Correct	bit	No	Is Option3 is Correct for question
23	OptionMarks3	int	No	Marks of Option 3 for question
24	Option4	string	No	Option 4 for question
25	OptionImage4	string	No	URL of Image of Option 4 for question
26	IsOption4Correct	bit	No	Is Option4 is Correct for question
27	OptionMarks4	int	No	Marks of Option 4 for question
28	Option5Text	string	No	Option 5 for question
29	OptionImage5	string	No	URL of Image of Option 5 for question
30	IsOption5Correct	bit	No	Is Option5 is Correct for question
31	OptionMarks5	int	No	Marks of Option 5 for question
32	ModelAnswer	string	No	Model Answer

Output

Sr No	Name	DataType	Description
1	Message	String	Message for success
2	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	QuestionID	Long	New question created QuestionID

9. Create multiple objective/subjective question API

Description: To add multiple objective/subjective question

URL: http://splashwebapi.eklavvya.in/SplashService.svc/AddMultipleQuestionWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	SubejctID	Long	Yes	Subject ID to identify the subject
2	SubjectName	string	Yes	Subject Name to identify the subject
3	TopicID	Long	Yes	Topic ID to identify the topic
4	TopicName	string	Yes	Topic Name to identify the topic
5	QuestionType	string	Yes	Question Type (MCQ , FILL IN BANKS, TRUE OR FALSE, MATCH THE PAIR , MULTISELECT, SUBJECTIVE )
6	DifficultyLevel	string	No	Difficulty Level (BASIC, EASY, MODERATE, HARD, DIFFICULT, Default: Basic)
7	Question	string	Yes	Question which on to added
8	Image	string	No	URL of Image for the question
9	Audio	string	No	URL of Audio for the question
10	Video	string	No	URL of Video for the question
11	Marks	int	Yes	Marks for the question
12	Option1	string	Yes	Option 1 for question
13	OptionImage1	string	No	URL of Image of Option 1 for question
14	IsOption1Correct	bit	Yes	Is Option1 is Correct for question
15	OptionMarks1	int	No	Marks of Option 1 for question
16	Option2	string	No	Option 2 for question
17	OptionImage2	string	No	URL of Image of Option 2 for question
18	IsOption2Correct	bit	No	Is Option2 is Correct for question
19	OptionMarks2	int	No	Marks of Option 2 for question
20	Option3	string	No	Option 3 for question
21	OptionImage3	string	No	URL of Image of Option 3 for question
22	IsOption3Correct	bit	No	Is Option3 is Correct for question
23	OptionMarks3	int	No	Marks of Option 3 for question
24	Option4	string	No	Option 4 for question
25	OptionImage4	string	No	URL of Image of Option 4 for question
26	IsOption4Correct	bit	No	Is Option4 is Correct for question
27	OptionMarks4	int	No	Marks of Option 4 for question
28	Option5Text	string	No	Option 5 for question
29	OptionImage5	string	No	URL of Image of Option 5 for question
30	IsOption5Correct	bit	No	Is Option5 is Correct for question
31	OptionMarks5	int	No	Marks of Option 5 for question
32	ModelAnswer	string	No	Model Answer

Output

Sr No	Name	DataType	Description
1	Message	String	Message for success
2	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	QuestionID	Long	New question created QuestionID

10. Update objective question API

Description: To Update the objective question

URL: http://splashwebapi.eklavvya.in/SplashService.svc/UpdateObjectiveQuestionAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr No	Name	Datatype	Is Required	Description
1	Subject ID	Long	Either one of them is required	Subject ID to identify the subject
2	Subject Name	String	Subject Name to identify the subject
3	Topic ID	Long	Either one of them is required	Topic ID to identify the topic
4	Topic Name	String	Topic Name to identify the topic
5	QuestionType	INT	Yes	Indicate Type of Question MCQ FILL IN BLANKS TRUE OR FALSE MATCH THE PAIR MULTISELECT
6	DifficultyLevel	INT	Yes	Indicate difficulty level Basic Easy Moderate Hard Difficult
7	Question	String	Yes	Question which on to added
8	Marks	INT	Yes	Mark for the question
9	Option1	String	Yes	Option 1 for question
10	Option2	String	Yes	Option 2 for question
11	Option3	String	No	Option 3 for question
12	Option4	String	No	Option 4 for question
13	Option5	String	No	Option 5 for question
14	CorrectOprionNo	String	Yes	Indicate option correct. Give option No which is correct
15	QuestionID	INT	Yes	To identify the question

Output

Sr No	Name	DataType	Description
1	Message	String	Message for success
2	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	QuestionID	Long	New question created QuestionID

11. Get exam name API

Description: To get exam details of exams of particular institute

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ GetExamNameWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	ExamType	String	NO	Examtype can be ‘Objective’,’Subjective’,’ObjectiveAndSubjective’
2	ScheduleType	String	NO	Schedule Type ‘Flexi’,’Fixed’,’FlexiWithFixed’
3	ExamName	String	NO	ExamName string contains in exam name

Test case:

Each parameter is optional, if no parameter is specified then all exams in given institute are returned

Output

Sr. No.	Name	Data Type	Description
1	EamID	Long	ExamID for particular exam
2	ExamName	String	Exam Name
3	ExamType	String	Examtype can be ‘Objective’,’Subjective’,’ObjectiveAndSubjective’
4	ScheduleType	String	Schedule Type ‘Flexi’,’Fixed’,’FlexiWithFixed’
5	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
6	objStatusCodes	INT	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

12. Create exam schedule API

Description: To create exam schedule

URL: http://splashwebapi.eklavvya.in/SplashService.svc/CreateExamScheduleApi

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	ExamID	Long	No	ExamID for identify the exam
2	ExamName	String	No	ExamName for identify the exam .ExamID or ExamName atleast one required
2	ScheduleDateTime	String	Yes	Start date of schedule
3	ExpireDateTime	String	Yes	End date of schedule
4	TimeZone	String	Yes	Country timezone

Please find available time zones from below link :

https://splashwebapi.eklavvya.in/Shared/Available_TimeZones.xslx

Output

Sr No	Name	DataType	Description
1	Message	String	Message for success
2	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	ScheduleID	Long	New schedule created schedulID

13. Update exam schedule API

Description: To Update the Schedule

URL: http://splashwebapi.eklavvya.in/SplashService.svc/UpdateExamScheduleAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No	Name	Datatype	Is Required	Description
1	ScheduleID	INT	Yes	T0 identify the Schedule
2	ExamID	INT	Either one of them is required	To identify the Exam
3	ExamName	STRING	To identify the Exam
4	ScheduleDateTime	STRING	Yes	Start date of Schedule
5	ExpireDateTime	STRING	Yes	End date of Schedule
6	TimeZone	STRING	Yes	To identify the time zone

Please find available time zones from below link :

https://splashwebapi.eklavvya.in/Shared/Available_TimeZones.xslx

Output

Sr No	Name	DataType	Description
1	Message	String	Message for success
2	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	ScheduleID	Long	Updated Schedule

14. Activate exam schedule API

Description: To active the Schedule

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ActiveExamScheduleWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No	Name	Datatype	Is Required	Description
1	ScheduleID	INT	Yes	To identify the Schedule

Output

Sr. No	Name	DataType	Description
1	Message	String	Message for success
2	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	ScheduleID	Long	Activated Schedule

15. Deactivate exam schedule API

Description: To deactivate the Schedule

URL: http://splashwebapi.eklavvya.in/SplashService.svc/DeactiveExamScheduleWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No	Name	Datatype	Is Required	Description
1	ScheduleID	INT	Yes	To identify the Schedule

Output

Sr. No	Name	DataType	Description
1	Message	String	Message for success
2	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	ScheduleID	Long	Deactivated Schedule

16. Get list of schedule API

Description: To get the list Schedule

URL: http://splashwebapi.eklavvya.in/SplashService.svc/GetExamScheduleListWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No	Name	Datatype	Is Required	Description
1	ExamID	INT	Either one of them is required	To identify the Exam
2	ExamName	STRING	To identify the Exam

Output

Sr. No	Name	DataType	Description
1	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
2	ScheduleDateTime	String	Start date of Schedule
3	ExpireDateTime	String	End date of Schedule
4	TimeZone	String	Time zone of schedule

17. Create Batch API

Description: To register candidate in Eklavvya Batch should be created first. As per Moodle course can act as Batch so that in future course wise (Batch wise) candidates will be assigned to created exams.

URL: http://splashwebapi.eklavvya.in/SplashService.svc/AddBatchWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	BatchName	String	Yes	Batch into which candidates will be added
2	BatchDescription	String	No	Extra Info about Batch

Test case:

Batch name should be unique.

Output

Sr. No.	Name	Data Type	Description
1	BatchID	Long	Created batch ID
2	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
3	objStatusCodes	INT	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

18. Register Candidate API

Description: To add or register candidate in Eklavvya

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ImportCandidate

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	UID	String	Yes	Roll No or Enrollment no of candidate which is unique for each candidate
2	FirstName	String	Yes	First name of candidate
3	LastName	String	Yes	Last name of candidate
4	EmailID	String	Yes	EmailID of candidate
5	MobileNo	String	Yes	Contact No of candidate
6	BatchName	String	Yes	Batch Name in which candidate should belongs to
7	Password	String	No	If not provided default password will be ‘test’
8	MiddleName	String	NO	Middle name of candidate

Test case:

● UID should be unique.

● EmailID should be valid

Output

Sr. No.	Name	Data Type	Description
1	StudentID	Long	Created Student ID
2	UID	String	Enrollment No which was provided
3	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
4	objStatusCodes	INT	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

19. Assign Candidate to Exam API

Description: To assign particular candidate to given Exam

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ AssignExamToCandidateWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	UID	String	Either one of them is required	Roll No or Enrollment no of candidate which is unique for each candidate
2	StudentID	String	Candidate unique ID generated by Eklavvya
3	ExamName	String	Yes	Exam Name to which candidate is to be assigned
4	ScheduleID	long	NO	Schedule id of schedule to which candidate to be assigned, If not provided then default created schedule will be assigned.

Output

Sr. No.	Name	Data Type	Description
1	ExamAssignmentID	Long	Created UNIQUE ID for particular candidate for particular exam
2	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
3	objStatusCodes	INT	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

20. Get Exam Results API

Description: To get exam results of particular candidate

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ GetExamDetailsByCandidateDataWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	EnrollmentNo	String	Either One of them is required	Roll No or UNIQUE ID number used while registering candidate
2	CandidateID	long	Eklavvya unique ID generated after registering candidate
3	ExamID	Long	NO	If provided result of particular exam is returned
4	ExamName	String	NO	If provided result of particular exam is returned
5	ScheduleID	long	NO	If provided result of particular schedule is returned

Output

Sr. No.	Name	Data Type	Description
1	CandidateExamDate	string	Candidate exam date
2	EndSchedule	String	End Schedule of Exam
3	ExamAssignmentID	long	Unique ID from particular Exam and particular Schedule
4	ExamID	long	ExamID
5	ExamName	String	Exam Name
6	ExamResult	String	Pass or Fail
7	ExamStatus	String	Yet To Start, Completed , Incomplete
8	Marks	Float	Marks obtained
9	Percentage	Float	Percentage
10	StartSchedule	String	Start Schedule of exam
11	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
12	objStatusCodes	INT	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

21. Get Exam Details API

Description: To get exam details of exams of particular candidate

URL: http://splashwebapi.eklavvya.in/SplashService.svc/GetExamDetailsByCandidateDataWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	EnrollmentNo	String	Either One of the three is required	Roll No or UNIQUE ID number used while registering candidate
2	CandidateID	long	Eklavvya unique ID generated after registering candidate
3	EmailID	String	Either one of the three is required	Email ID of candidate
4	ExamID	long		ExamID for particular exam
5	ExamName	String		Exam Name

Output

Sr. No.	Name	Data Type	Description
1	ExamID	Long	ExamID for particular exam
2	ExamName	String	Exam Name
3	ExamURL	String	ExamURL of exam
4	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
5	objStatusCodes	INT	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

22. Create Exam Web API

Description: To create exam details

URL: http://splashwebapi.eklavvya.in/SplashService.svc/CreateExamWebAPI

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters:

ExamObj:

Sr. No.	Name	Data Type	Is Required	Description
1	ExamName	string	Yes	Exam Name
2	ExamDuration	int	Yes	Time duration of exam in minutes
3	ExamType	int	No	Multiple Choice:1, Subjective/Theory:2, Both type:3
4	ScheduleStartDate	string	Yes	Start date of schedule (yyyy-mm-dd),
5	ScheduleEndDate	string	Yes	End date of schedule (yyyy-mm-dd),
6	TimeZone	string	Yes	Country time zone
7	ExamScheduleType	int	No	(Flexi:0, Fixed:1, FlexiWithFix:2)
8	AllowInstantScoreView	bit	No	Allow Instant Score View (Yes:1,No:0)
9	AllowReviewExam	bit	No	Allow Review Exam (Yes:1,No:0)
10	NegativeMarking	bit	No	Allow Negative Marking (Yes:1,No:0)
11	NegativeMarks	int	No	Negative Marks
12	SeparateTimeForEachQuestion	bit	No	Separate Time For Each Question (Yes:1,No:0)
13	TimerInSeconds	int	No	Timer For Each Question In Seconds
14	RandomizeQuestion	bit	No	Allow Randomize Question (Yes:1,No:0)
15	ShuffleQuestion	bit	No	Allow Shuffle Question (Yes:1,No:0)
16	AllowRemoteProctoring	bit	No	Allow Remote Proctoring (Yes:1,No:0)
17	AudioStreaming	bit	No	Allow Audio Streaming (Yes:1,No:0)
18	ScreenStreaming	bit	No	Allow Screen Streaming (Yes:1,No:0)
19	CaptureCandidatePhoto	bit	No	Capture Candidate Photo (Yes:1,No:0)
20	AllowQuestionNavigation	bit	No	Allow Question Navigation (Yes:1,No:0)
21	ConductExamInTwoLanguages	bit	No	Conduct Exam In Two Languages (Yes:1,No:0)
22	PrimaryLanguage	string	No	Primary Language For Exam
23	SecondaryLanguage	string	No	Secondary Language For Exam

QuestionObj:

Sr. No.	Name	Data Type	Is Required	Description
1	SubejctID	Long	Yes	Subject ID to identify the subject
2	SubjectName	string	Yes	Subject Name to identify the subject
3	TopicID	Long	Yes	Topic ID to identify the topic
4	TopicName	string	Yes	Topic Name to identify the topic
5	QuestionType	string	Yes	Question Type (MCQ , FILL IN BANKS, TRUE OR FALSE, MATCH THE PAIR , MULTISELECT, SUBJECTIVE )
6	DifficultyLevel	string	No	Difficulty Level (BASIC, EASY, MODERATE, HARD, DIFFICULT, Default: Basic)
7	Question	string	Yes	Question which on to added
8	Image	string	No	URL of Image for the question
9	Audio	string	No	URL of Audio for the question
10	Video	string	No	URL of Video for the question
11	Marks	int	Yes	Marks for the question
12	Option1	string	Yes	Option 1 for question
13	OptionImage1	string	No	URL of Image of Option 1 for question
14	IsOption1Correct	bit	Yes	Is Option1 is Correct for question
15	OptionMarks1	int	No	Marks of Option 1 for question
16	Option2	string	No	Option 2 for question
17	OptionImage2	string	No	URL of Image of Option 2 for question
18	IsOption2Correct	bit	No	Is Option2 is Correct for question
19	OptionMarks2	int	No	Marks of Option 2 for question
20	Option3	string	No	Option 3 for question
21	OptionImage3	string	No	URL of Image of Option 3 for question
22	IsOption3Correct	bit	No	Is Option3 is Correct for question
23	OptionMarks3	int	No	Marks of Option 3 for question
24	Option4	string	No	Option 4 for question
25	OptionImage4	string	No	URL of Image of Option 4 for question
26	IsOption4Correct	bit	No	Is Option4 is Correct for question
27	OptionMarks4	int	No	Marks of Option 4 for question
28	Option5Text	string	No	Option 5 for question
29	OptionImage5	string	No	URL of Image of Option 5 for question
30	IsOption5Correct	bit	No	Is Option5 is Correct for question
31	OptionMarks5	int	No	Marks of Option 5 for question
32	ModelAnswer	string	No	Model Answer

Output

Sr. No.	Name	Data Type	Description
1	QuestionID	Long	QuestionID for particular question
2	ExamID	Long	ExamID for particular exam
3	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
4	objStatusCodes	INT	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

23. LoginCandidate API

Description: This API is used for candidate login.

URL: https://splashwebapi.eklavvya.in/SplashService.svc/LoginCandidateWebAPI

Method: POST

Headers:

“authenticationkey”:”Tamanna@786”

This authentication key belongs to my personal institute .

Input/output Content Type: JSON

Parameters:

Sr.No	Name	Data Type	IsRequired	Description
1	Username	String	Yes	It is candidates username used to login.
2	ExamID	Int	No	ExamID to identify exam.
3	ExamName	String	No	Exam Name to identify the exam.
4	ScheduleID	Int	No	Schedule Id to identify the schedule.
5	ScheduleStartDate	DateTime	No	Start date of schedule
6	ScheduleEndDate	DateTime	No	End date of schedule

Output:

Sr.No	Name	Data Type	Description
1	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message.
2	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty
3	RedirectionPageURL	String	It is RedirectionPageURL after Login is successful.

Note:

1. If we provide only username then exam selection page url is returned.

2. If we provide username and exam details then exam page url is returned.

24. ResetPassword

Description: This API is used to reset password for particular candidate.

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ResetPassword

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	UID	string	Either One of them is required	User ID or Roll Number for particular student
2	StudentD	int	StudentID for particular student
	3	EmailID	string	EmailID for particular student
4	NewPassword	string	Yes	New password

Output

Sr. No.	Name	Data Type	Description
1	StudentID	Long	It shows Student ID
2	UID	String	It show Roll No or User ID
3	BatchID	Int	It show BatchID
4	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
5	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty

25. ForgotPassword

Description: This API is used to get password and password reset link for particular candidate if candidate forgot its login password.

URL: http://splashwebapi.eklavvya.in/SplashService.svc/ForgotPassword

Method: POST

Headers:

“authenticationkey”:” Will be provided at the time of integration”

Input/output Content Type: JSON

Parameters

Sr. No.	Name	Data Type	Is Required	Description
1	UID	string	Either One of them is required	User ID or Roll Number for particular student
2	EmailID	string	EmailID for particular student

Output

Sr. No.	Name	Data Type	Description
1	StudentID	Long	It shows Student ID
2	UID	String	It show Roll No or User ID
3	BatchID	Int	It show BatchID
4	Message	String	If any exception not occurred then value of Message will be ‘SUCCESS’ otherwise it will be customized error message
5	objStatusCodes	Int	Indicates status of API output 1 = Success 2 = Error 3 = Required field empty