Class: V1::ParticipantImportActionsController

Inherits:
ApiController
  • Object
show all
Defined in:
api/app/api/v1/participant_import_actions_controller.rb

Overview

Allows creation and tracking of Participant Import Actions

Instance Method Summary collapse

Instance Method Details

#create ⇒ Hash<String, ParticipantImportAction>

Create a ParticipantImportAction

Options

  • [Integer] participant_import_id (required) an internal identifier used by RedJade to track the payload, returned by POST /v1/participant_imports
  • [Boolean] save_missing_categories (default true) save any missing demographic categories included in your payload.
  • [Boolean] only_demographics (default false) only create the included demographics for matched participants (we connected existing participants with external id or email)
  • [Boolean] destroy_existing_demographics (default false) destroy all existing demographics for matched participants (we connected existing participants with external id or email)
  • [Boolean] destroy_unmatched_participants (default false) destroy all existing participants for this event that were not included in the payload (and matched on external id or email)
  • [Boolean] skip_invalid (default false) ignores all invalid participants
  • [Boolean] skip_duplicate_identity_matches: (default false) skip over any duplicates when importing

Example

After review, proceed with import ID 24

    {
      "participant_import_id": 24,
      "save_missing_categories": true,
      "only_demographics": false,
      "destroy_existing_demographics": false,
      "destroy_existing_demographics": false,
      "destroy_unmatched_participants": false,
      "skip_invalid": false,
      "skip_duplicate_identity_matches": false
    }

Returns:

#index ⇒ Hash<String, Array<ParticipantImportAction>>

Retrieve all ParticipantImportAction for a given ParticipantImport

Returns:

#show ⇒ Hash<String, ParticipantImportAction>

Retrieve a particular ParticipantImportAction A likely use case for this end point would be checking the status of the job

Returns: