GetScheduleListByParticipantV42

Applies to the following products:

Questionmark OnDemand

Questionmark Perception

Questionmark OnPremise

Applies to the following Perception versions:

Perception 5.7

This method processes a participant ID and returns a list giving the full details of all the schedules that are assigned to the participant if the participant ID exists and has any schedules assigned to it. The schedules in the list include those for all participants assigned to the schedule, whether the participant is assigned directly to the schedule, or whether the participant belongs to a group that is assigned to the schedule. This method will return information about schedules that were generated by:

The list of available schedules will only include schedules created for web delivery and not for Questionmark to Go or test centers. The list of schedules returned will not necessarily be the same as displayed when a participant logs in to Perception. The list of assessments scheduled differ when a participant logs in because the system also takes into account the following, which this method does not:

test centers assigned
Schedule start and stop times
Days between attempts
Restricted attempts at an assessment

If the participant ID does not exist a SOAP fault message will be returned.

Available in:

Version 4.4 +
Version 5.1 +

Parameter

Input name	Description	Data type	Optional field?
participantId	The participantId of the participant whose assigned schedule details are required. If this is 0 then the response will contain all 'Group Schedules'. A Group Schedule is a schedule that applies to any member of a group rather than to a specific participant. In Enterprise Manager, Group Schedules can only be created when attempts are unlimited.	Integer	N

Response

Output name		Description	Data type
Schedule (may occur several times)
	Schedule_ID	The Schedule_ID of this schedule	Integer
	Assessment_ID	The Assessment_ID of the assessment in this schedule	String
	Participant_ID	If a participant is scheduled, this is their participant ID, otherwise it is zero (because a group is scheduled)	Integer
	Group_ID	If Participant_ID above is zero, a group is scheduled and this is its group ID, otherwise this is either the group ID that the participant belongs to, or is zero if the participant does not belong to a group	Integer
	Group_Tree_ID	The lowest level group ID that the participant being scheduled is associated with	Integer
	Schedule_Name	A descriptive name for this schedule	String
	Restrict_Times	This indicates whether Schedule_Starts and Schedule_Stops below are used to restrict the period for which the assessment is available	Boolean
	Restrict_Attempts	This indicates whether or not Max_Attempts below is used to limit the number of attempts	Boolean
	Max_Attempts	This is the maximum number of times this schedule can be accessed	Integer
	Monitored	0 - Assessment in schedule not monitored 1 - Assessment in schedule monitored	Integer
	Schedule_Starts	If Restrict_Times above is set, this is the date and time at which this schedule becomes available	Date/Time
	Schedule_Stops	If Restrict_Times above is set, this is the date and time at which this schedule ceases to be available	Date/Time
	Test_Center_ID	The Test_Center_ID of the test center where this schedule had to be taken	Integer
	Min_Days_Between_Attempts	The minimum number of days that need to elapse before a participant can take the assessment again	Integer
	Time_Limit_Override	Determines if the time limit set in the assessment should be overridden	Boolean
	Time_Limit	If Time_Limit_Override is enabled this is the number of minutes in total that the participant now has to take the assessment	Integer
	Participant_Name	The name of the participant	String
	Group_Name	The name of the group that the participant is apart of	String
	Test_Center_Name	The name of the Test_Center identified in Test_Center_ID	String
	Web_Delivery	Determines if the participant can access the assessment from perception.dll or perception.php	Boolean
	Offline_Delivery	Determines if the assessment is available for download	Boolean
	APack4URL	The URL of the assessment download	String

Troubleshooting

Please refer to the following page for any error codes that are displayed when using this method.

Appendix - Error codes