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::getSurveyQueueLink
(REDCap >= 5.11.0)
REDCap::getSurveyQueueLink
— Obtains the survey queue link for a specific record in a project in which the Survey Queue has been enabled
Description
string REDCap::getSurveyQueueLink ( string $record [, int $project_id = NULL ] )
Obtains the survey queue link for a specific record in a project in which the Survey Queue has been enabled. If the Survey Queue has not been enabled, then NULL will be returned. NOTE: The survey queue link is different from a survey link, which will be unique for each record-instrument[-event]. There will only ever be one survey queue link per record in a project, while there may be many survey links for the record (depending on the number of surveys and events in the project). For more information on the Survey Queue, see the documentation inside the Survey Queue popup on the Online Designer page in any project.
Parameters
record
The name of the record/response in the project.
The name of the record/response in the project.
project_id
The project ID (PID) number of the project. This parameter is optional if this method is called within the project context. Providing project_id allows this method to be called outside the target project context.
The project ID (PID) number of the project. This parameter is optional if this method is called within the project context. Providing project_id allows this method to be called outside the target project context.
Return Values
Returns the survey queue link (i.e., full survey queue URL) for this record. If the Survey Queue has not been enabled, then NULL will be returned.
Restrictions
If the project_id parameter is not provided explicitly, then this method can ONLY be used in the target project's 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 illustrates how to obtain the survey queue link for a specific record.
// We have our record name $record = '101'; // Get the survey queue link for this record $survey_queue_link = REDCap::getSurveyQueueLink($record);
REDCap 14.9.1 - © 2024 Vanderbilt University