Import Exhibitors by JSON

Import Exhibitors for a Task

This endpoint is used to initiate the "import process for exhibitors" associated with a specific event by providing exhibitor data as JSON. 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

  • ApiExhibitorImport

Request

The request object StartExhibitorImportRequest will be delivered in JSON format. In this variant, you must provide the Data array.

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

• Method: POST

• URL: https://dev.aditus.de/ADITUS-DEV-0_API/api/tasks/exhibitors/import

Headers

• Content-Type: application/json

• Accept: */*

Request Body

The request body must be in JSON format and contains the following parameter:

• FaireventId: represents the ID of the fair event for which the exhibitors are being imported. This parameter is essential for identifying the specific event.
  Here you can use one of the following properties of the fair event:

  • internal Id: 42 or "42"

  • unique id: "C8847785-CF69-EE11-93CF-00155D960409"

  • slug: "hmmcc23"

  • year and faireventnumber: "2023-6189" (format: YYYY-nnn)

• FaireventExternalId - The external id 1 or 2 or 3 of the fairevent.
  You can also use the fairevent external id. For this you must set faireventId to null

• 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. The default value: 0 (NoImport).

  • 0 = NoImport

  • 1 = ActivationMail (the user gets an activation mail for his account)

  • 2 = DeepLinkImport (the deep link for the account will be imported with the import data)

  • 3 = DeepLinkCreation (the deep link for the account will be created during the 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.

  • ArticleId
    Here you can use one of the following properties of the article:
    internal Id: 186 or "186"
    unique id: "37A8A129-D669-EE11-93CF-00155D960409"

  • ArticleNumber
    You can also use the article number. For this you must set ArticleId to null

  • ArticleExternalId
    The external id 1 or 2 or 3 of the article. You can also use the article external id. For this you must set articleId and article number to null

  • QuotaColumn
    Assignment to configured Column in "Data", for example: TicketQuota1

• ExhibitorAppearanceChangeMode (enum) 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

• Data Exhibitor import data in JSON format.

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, json import, data array, start task, create import