This API will be used to register candidates.
Request Parameters: The name, email, and password are required.
The password is encoded in base64.
Custom-Header {
"name": "{{Client URL}}"
}
{{API Endpoint}}/api/v1/newUser
BodyCopy {
"name": "{candidateName}",
"password": "{Password}",
"enrollment_number": "{RollNumber}",
"email": "{Emailid}",
"mobile": "{MOBILE NUMBER}",
"profilePic": "{Base64 Image}",
"gender": "{Gender}",
"dob": "{DOB}",
"country": "{countryName}",
"courseId": "{courseId}",
"courseName": "{courseName}",
"isMailEnable": "{0 or 1}",
"reg_date": "{regDate}",
"isLinkBasedTest": "{0 or 1}",
"clientStudentUniqueId": "{UniqueId}",
"state": "{StateName}",
"city": "{CityName}",
"address": "{A ddress}",
"pincode": "{Pincode}",
"signaturePic": "{SignaturePic}",
"idProfilePic": "{idProfilePic}",
"extra1": "{extra1}",
"extra2": "{extra2}",
"extra3": "{extra3}",
"extra4": "{extra4}",
"extra5": "{extra5}",
"extra6": "{extra6}",
"extra7": "{extra7}",
"phone": "{phone}"
}
| Parameters | Value | Mandatory |
|---|---|---|
| name | Name of candidate | Yes |
| password | Password of the candidate (If password is passed in the api then Password must be One Upper,One Lower,One Special Character & Minimum length should be 8) | No |
| Email address of candidate | Yes | |
| enrollment_number | Roll number of the candidate | No |
| mobile | Candidate’s mobile number | No |
| profilePic | Candidate profile picture in base64 format | No |
| gender | Gender of the candidate | No |
| dob | Date of birth of the candidate | No |
| courseId or courseName | Course Id or Course name represent to the group assigned to the candidate | Yes |
| reg_date | Registration Date of the candidate | No |
| isLinkBasedTest | If test is link based send 0 or 1 | No |
| clientStudentUniqueId | Unique Id of the student | No |
| isMailEnable | If Email enable Sent 0 or 1 | No |
| country | Country name represent to the candidate’s country | No |
| state | State name represent to the candidate’s state | No |
| city | City name represent to the candidate’s state | No |
| address | Address of the candidate | No |
| pincode | Pincode of the candidate | No |
| signaturePic | Signature pic of the candidate | No |
| idProofPic | Id proof pic of the candidate | No |
| extra1 | Additional Parameter | No |
| extra2 | Additional Parameter | No |
| extra3 | Additional Parameter | No |
| extra4 | Additional Parameter | No |
| extra5 | Additional Parameter | No |
| extra6 | Additional Parameter | No |
| extra7 | Additional Parameter | No |
| phone | Another phone of the candidate | No |
Case 1 : When SuccessSuccess {
"result": "success",
"success": {
"msg": "Registration Successful"
},
"status": "1",
"data": {
"profilePic": "",
"studentId": 32978025,
"enrollmentNo": ""
},
"ACCESS_TOKEN":"rOodjY8tsKjjhVmvWZ*FKtUVLln40BXC6Dk1iplgvyuYTtNYFtSj6sqXTrWc10InkjUOuW+HJ5bqctzIpwdKmre90A0YNtwtr8Op0dXGLrLNDrma5eJ88ieqUWN1nDzCiga*KCQ2IqiHntFcM3TUbGqFNhf7opKWLvubT3YsCq2tu1GEjTTWN75frGAhvegm0Jj44S+RP6G3d4webJUuD5XICAArMiGbkAa+8PhvjHbnOaLDiUMP3Bds7ew8uY+W5dPPUg71IuMw*QhSHjlZAudDaD1q3FBbuFS5AmbJc4lVm5ntX8HHcHn5ElIwwCAVE61hNlTyU699eYqruAR4J78ReFkt1C7JekcaQn6AFWpUWO7M5j*xygQyTY6dv7nw+lba+APJCP+BEpMVWJJmSg==",
"LARAVEL_TOKEN":"6yeY18koE6cB9ieTT70zKwfg1iAh8ewPeSuTQMyEgeVKgWXAW7U4pEFuVXc4a568QeECfuRsfIFgxyvGSxhuw=="
}
Case 2 : When Invalid ParameterError {
"result": "error",
"error": {
"code": "3011",
"msg": "Invalid Parameter"
}
}
Case 3 : When Duplicate StudentError {
"result": "error",
"error": {
"msg": "Email Address already registered"
},
"status": "0",
"LARAVEL_TOKEN":"6yeY18koE6cB9ieTT70zK+kzzH7KKgkJ4UMBYwsLXkj9VjO3QqkbpWgWb9vQWolQZPMIWnU8u4FuRyT3uxZubw==",
"ACCESS_TOKEN": ""
}
Case 4 : When Registration Closed by AdminError {
"result":"error",
"error":{
"code":"3029",
"msg":"Registration is closed."
}
}