Bulk Registration Candidate

Bulk Registration Candidate

POSTBulk Registration Candidate

This API will be used to register or log in a candidate. Additionally, this API is used to assign another course to a registered candidate.

Name and email address are required fields.

Pass ak, sgn, and ts as headers, and all three parameters will be received using the Signature Generation API.

Header
ak:{{API Key}}
sgn:{{sgn}}
ts:{{ts}}

URL
Copy
{{API Endpoint}}/api/v1/bulkCandidateRegister

Body
Copy
[
    {
        "name": "{Candidate Name}",
        "enrollment_number": "{Candidate Enrollment Number}",
        "email": "{Candidate Email}",
        "password": "{Candidate Password}",
        "mobile": "{Candidate Mobile No.}",
        "gender": "{Candidate Gender}",
        "dob": "{Candidate DOB}",
        "courseName": "{Candidate Course Name}",
        "extra1": "{Extra Value}",
        "extra2": "{Extra Value}",
        "extra3": "{Extra Value}",
        "profilePic": "{Candidate Profile Pic}"
    },
    {
        "name": "{Candidate Name}",
        "enrollment_number": "{Candidate Enrollment Number}",
        "email": "{Candidate Email}",
        "password": "{Candidate Password}",
        "mobile": "{Candidate Mobile No.}",
        "gender": "{Candidate Gender}",
        "dob": "{Candidate DOB}",
        "courseName": "{Candidate Course Name}",
        "extra1": "{Extra Value}",
        "extra2": "{Extra Value}",
        "extra3": "{Extra Value}",
        "profilePic": "{Candidate Profile Pic}"
    },
    {
        "name": "{Candidate Name}",
        "enrollment_number": "{Candidate Enrollment Number}",
        "email": "{Candidate Email}",
        "password": "{Candidate Password}",
        "mobile": "{Candidate Mobile No.}",
        "gender": "{Candidate Gender}",
        "dob": "{Candidate DOB}",
        "courseName": "{Candidate Course Name}",
        "extra1": "{Extra Value}",
        "extra2": "{Extra Value}",
        "extra3": "{Extra Value}",
        "profilePic": "{Candidate Profile Pic}"
    },
    {
        "name": "{Candidate Name}",
        "enrollment_number": "{Candidate Enrollment Number}",
        "email": "{Candidate Email}",
        "password": "{Candidate Password}",
        "mobile": "{Candidate Mobile No.}",
        "gender": "{Candidate Gender}",
        "dob": "{Candidate DOB}",
        "courseName": "{Candidate Course Name}",
        "extra1": "{Extra Value}",
        "extra2": "{Extra Value}",
        "extra3": "{Extra Value}",
        "profilePic": "{Candidate Profile Pic}"
    }
]
Response
Case 1 : When Registration Success
Success
{
    "responseArray": [
        {
            "result": "success",
            "success": {
                "msg": "Registration Successfull."
            },
            "data": {
                "studentId": 85638919,
                "enrollmentNo": "GW2901",
                "profilePic": "https://gw-thinksaasmerged-deploy.s3-ap-south-1.amazonaws.com/student/assets6/image/profile.png"
            },
            "laravelToken": "6yeY18koE6cB9ieTT70zKwXkJvamiwdfAE1hxasUIShn4wbGGYELS5lbtzky+3UF2GBAizgLNblCjzV6wSLGog=="
        },
        {
            "result": "success",
            "success": {
                "msg": "Registration Successfull."
            },
            "data": {
                "studentId": 85638920,
                "enrollmentNo": "GW2902",
                "profilePic": "https://gw-thinksaasmerged-deploy.s3-ap-south-1.amazonaws.com/student/assets6/image/profile.png"
            },
            "laravelToken": "6yeY18koE6cB9ieTT70zKwXkJvamiwdfAE1hxasUISgdOq1clQBSNfbCbjgDJJas3oKr*rIVU7dNlQKMp6wihw=="
        },
        {
            "result": "success",
            "success": {
                "msg": "Registration Successfull."
            },
            "data": {
                "studentId": 85638921,
                "enrollmentNo": "GW2903",
                "profilePic": "https://gw-thinksaasmerged-deploy.s3-ap-south-1.amazonaws.com/student/assets6/image/profile.png"
            },
            "laravelToken": "6yeY18koE6cB9ieTT70zKwXkJvamiwdfAE1hxasUISgUAcIkTiUo5GOzyecRS+tIDEDY3banlJOwDSBhYYV0WQ=="
        }
    ],
    "result": "Success"
}

Case 2 : When filed not exist
Error
{
    "result": "error",
    "error": {
        "code": "3084",
        "msg": "{field name} not exist."
    }
}

Case 3 : When Details is missing
Error
{
    "result": "error",
    "error": {
        "code": "3023",
        "msg": "{field name} should not be blank"
    }
}

    • Related Articles

    • How to enable Registration for the candidates?

      Steps to Enable Candidate Registration: Step 1 : Login to the Admin Panel. Step 2 : In the Account section, under Account Information, you will find the option for Candidate Registration. To enable candidate registration, click on the Edit button and ...

    • Register / Login Candidate with test link

      POSTRegister / Login Candidate with test link This API will be used to register or log in a candidate. Additionally, this API is used to assign another course to a registered candidate. Name and email address are required fields. Pass ak, sgn, and ts ...

    • Assign Test to Bulk Candidates

      POSTAssign Test to Bulk Candidates This API will be used to assign tests directly to the candidates. Pass ak, sgn, and ts as headers, and all three parameters will be received using the Signature Generation API. Headerak:{{API Key}} sgn:{{sgn}} ...

    • How To Add Candidates From The Admin Panel?

      Candidate : Overview The “Candidate” Tab allows you to add candidates either manually or you can import via an excel upload. You can create different groups and you can also associate candidates with each group. This helps us assign Tests to a ...

    • Candidate Change Password

      GETCandidate Change Password This API will be used to update the candidate's password. Pass ak, sgn, and ts as headers, and all three parameters will be received using the Signature Generation API. Headerak:{{API Key}} sgn:{{sgn}} ts:{{ts}} URL ...