Plugins, Hooks, & External Modules
Developer methods for
Plugins, Hooks, & External Modules
Hook functions
REDCap Developer Tools:
Documentation for Plugins, Hooks, & External Modules
REDCap Version 14.9.1
REDCap::getEventIdFromUniqueEvent
(REDCap >= 6.4.0)
REDCap::getEventIdFromUniqueEvent
— Returns the event_id associated with an event in a longitudinal project when given its associated unique event name
Description
int REDCap::getEventIdFromUniqueEvent ( string $unique_event_name )
Returns the event_id associated with an event in a longitudinal project when given its associated unique event name.
Parameters
unique_event_name
The unique name of the event, as provided on the project's Define My Events page.
The unique name of the event, as provided on the project's Define My Events page.
Return Values
Returns the event_id number of the event. Returns FALSE if project is not longitidinal or if the unique event name is not valid.
Restrictions
This method can ONLY be used in a project context (i.e. when "pid" parameter is in the query string of the plugin URL) or else a fatal error is produced.
Examples
Example #1:
This example shows how to obtain the event_id for a given event using the unique event name, and then use the event_id to obtain a survey Participant List.
// Check if project is longitdudinal first
if (!REDCap::isLongitudinal()) exit("Cannot get event_id because this project is not longitudinal.");
// We have the unique event name and a unique instrument name for a survey
$unique_event = 'screening_arm_1';
$instrument = 'enrollment_survey';
// Get the event_id from the the unique event name
$event_id = REDCap::getEventIdFromUniqueEvent($unique_event);
// Now use the event_id and instrument name to fetch the survey's Participant List in CSV format
$participant_list_csv = REDCap::getParticipantList($instrument, $event_id);
REDCap 14.9.1 - © 2024 Vanderbilt University