Data Import
      Back to home
      1. Administrator Knowledge Base
      2. Admin Application Guides
      3. Data Import

      Certiverse Eligibility API: Upload Candidate Eligibility File

      Certiverse Eligibility API: Upload Candidate Eligibility File

      The "Upload Eligibility" functionality allows users to bulk add, update, and delete candidate eligibility records by uploading a .CSV file. This feature streamlines the process of managing candidate eligibility by supporting actions such as adding, updating, or deleting eligibility records for an organization. This article outlines how to use the "Upload Eligibility" feature, including file format requirements, required and optional fields, and the rules governing each action.

      File Upload Process

      Steps to Upload the Eligibility File:

      1. Navigate to the Eligibility tab in the Store Portal: Go to the eligibility section of the platform where you need to bulk add, update, or delete eligibility data.

      2. Click the "Upload Eligibility" Button: The "Upload Eligibility" button is located at the top of the screen. Clicking this will prompt you to upload your CSV file.

      3. Prepare Your CSV File: Ensure that the file is properly formatted with the correct headers and required data. The file should conform to the field and data requirements listed above.

      4. Select the File to Upload: Choose the file you wish to upload. The system will validate the format and data of the file.

      5. Review Data and Confirm Upload: After the file is uploaded, review the data and confirm that it is correct. Any errors will be displayed for correction before proceeding.

      6. Process the Upload: Once you confirm the data, the system will process the file according to the actions specified (ADD, UPDATE, DELETE). Any records that do not meet validation criteria will be flagged for correction.

      See here for a step-by-step video tutorial.

      Eligibility File Format

      • Things to consider:
        • The system will ignore any extra data beyond the specified fields for DELETE actions.
        • Multiple actions (ADD, UPDATE, DELETE) of eligibility can be uploaded with one .CSV file.

      Header

      Required

      Data Type

      Data Requirements
      Action Optional String

      Summary:

      Specify intended action ADD, DELETE, UPDATE. If omitted all records will be treated as an ADD.

      Notes:

      Booking cannot exist for eligibility for both UPDATE and DELETE actions.
      Eligibility Id Optional String

      Summary: 

      If the Eligibility Id is omitted when conducting an ADD Eligibility File, a GUID will be assigned as the Eligibility Id, and returned in the result file

      Notes:

      The Eligibility Id field is mandatory for UPDATE and DELETE actions.
      Candidate Id Optional String

      Summary:

      Candidate Id is stored in Certiverse as the Client Candidate Id.
      First Name Optional String

       
      Last Name Optional String

       
      Email Yes String

      Summary:

      The Email field must contain a valid email address.
      Exam Code Yes String

      Summary:

      The Exam SKU/Code must match a valid value in the Org.
      Eligibility Start Optional String

      Summary:

      Date-time is UTC, and must use a valid date-time format ("YYYY-MM-DD H:MM"). If the time is omitted, the time will be set to 12:00 AM.
      Eligibility End Optional String

      Summary:

      Date-time is UTC, and must use a valid date-time format ("YYYY-MM-DD H:MM"). If the time is omitted, the time will be set to 12:00 AM.
      Delivery Start Optional String

      Summary:

      Date-time is UTC, and must use a valid date-time format ("YYYY-MM-DD H:MM"). If the time is omitted, the time will be set to 12:00 AM.
      Delivery End Optional String

      Summary:

      Date-time is UTC, and must use a valid date-time format ("YYYY-MM-DD H:MM"). If the time is omitted, the time will be set to 12:00 AM.

      Download Candidate Eligibility File Sample

       

      Contact Us

      If you have any questions or need additional assistance, please contact us by either emailing support@certiverse.com or by submitting a ticket from this article.