Import Exhibitors by Excel

Import Exhibitors Task

This endpoint is used to initiate the "import process for exhibitors" associated with a specific event by uploading an Excel file. By sending a POST request to this endpoint, the backend system creates an ExhibitorImportTask and starts processing the import of exhibitor data asynchronously.

Auth and Role

• Auth
  OAuth 2.0 (inherit from collection)

• Required role
  BASEROLE APITASKS

Request

The request object StartExhibitorImportRequest will be delivered in JSON format. In this variant, you must provide the File object containing Excel content.

Exactly one of Data or File must be present — if Data is used, see the JSON request.

• Method: POST

• URL: {{API_BASE_URL}}/tasks/exhibitors/import

Headers

• Content-Type: application/json

• Accept: */*

Request Body

The request body must be in JSON format and contains FaireventId:

• FaireventId: represents the ID of the fair event for which the exhibitors are being imported. This parameter is essential for identifying the specific event.

• UserImportDate (DateTime?, optional) – when to send activation mail (if UserImportMode uses ActivationMail). Default is null which results in an immediate sending of the e-mail.

• UserImportMode (enum, optional) – how users are imported. Possible values are:

  • 0 = NoImport -> default -> No users should be imported.

  • 1 = ActivationMail -> Users should be imported. Activation of accounts will be processed via activation mails.

  • 2 = DeepLinkImport -> Users should be imported. They should gain access to the system by deep link token read from the import file.

  • 3 = DeepLinkCreation -> Users should be imported. They should gain access to the system by deep link token read created during import.

  • 4 = ActiveUser -> The user's account will be immediatly activated

• InformUsers: If "true" and if ImportMode is "ActiveUser" then the new user gets an e-mail about the details of his account. Default: false

• TicketQuotas Listing of ticket quota column / article mappings.

• ExhibitorAppearanceChangeMode allows assigning an already imported fairevent appearance to another exhibitor. Possible values are:

  • NoImport -> An already imported exhibitor appearance remains unaffected.

  • AssignAnotherExhibitor -> An already imported exhibitor appearance can be assigned to another exhibitor.

• EnableDetailedResult (bool) include info messages in result. Default: false

• CheckSkip (bool) Enable the check to determine if the file is identical to the previously executed import of the same event. If true, the processing is terminated early and the import execution is skipped. The defalt value: true.

• InformExistingExhibitors (bool) inform existing exhibitor about new appearance. Default: false

• File Exhibitor import Excel file information.

File object fields

"FileType": "xlsx", 
"Encoding": "UTF-8", 
"IsArchive": false,
"Data" : (string): Excel content 

Response

The response structure will provide feedback on the success or failure of the import operation. While the exact response structure is not detailed here, users can expect a confirmation of the import status, along with any relevant messages or error details if applicable.

201 CREATED

• Default success code for creation - resource has been created successfully.

• The location header points to the URL of the created task (api/tasks/exhibitors/import/{id}).

• Alternatively, you can read result.import.id from the response body to build the status URL.

400 BAD REQUEST
Default Error Code - Used if an object has invalid parameters, for more information about this read "Errors".

500 INTERNAL SERVER ERROR
Default Error Code - Used if an exception occurs


Next Steps

1. Poll GET "/tasks/exhibitors/import/{id}" until status is "Completed"

2. Retrieve result with GET "/tasks/exhibitors/import/{id}/result"

Usage

• To use this endpoint effectively, ensure that the FaireventId is correctly populated with the relevant event data. This will ensure that the import operation targets the correct exhibitors associated with the specified fair event.

• Use "EnableDetailedResult=true" to get extended logs in the result.

Response Structure

If the process is successful, the server returns a 201 Created status with details of the imported task.

Keywords: exhibitor import, excel import, xlsx, file upload, start task, create import