IMPORTANT: Questionmark recommendeds using the Delivery Odata API (click here for documentation) for new integrations, not the QMWISe API. Although we currently continue to issue maintenance updates to this API to support customers with current QMWISe-based integrations, we are no longer adding new methods/functionality to QMWISe. 
  1. Questionmark QMWISe API Guide
  2. Web service methods
  3. Schedule
  4. CreateAndScheduleParticipant

CreateAndScheduleParticipant

Applies to the following products: 
Questionmark OnDemand
Questionmark Perception
Questionmark OnPremise
Applies to the following Perception versions: 
Perception 5.7

This method creates and schedules a participant, it will add the participant to the database if they do not already exist, along with all details supplied, but for existing participants (where the Participant_Name matches) any details supplied will be overwritten, while any details that are blank will not be overwritten and the existing details will be returned in the response. The method will also:

  • If the password supplied is blank a random password will be generated
  • The participant will be added to any groups referenced if they are not already members
  • An individual schedule will be created for each assessment listed if it exists and if it is allowed to be run from integration (the ScheduleList may be blank if only the participant is required to be created or amended)
  • A list of schedule IDs will be returned for all assessments that they could be scheduled to (those assessments that could not be scheduled will be indicated by a Schedule_ID of 0)

If the participant cannot be created/edited and the schedule created with the information provided a SOAP fault message will be returned. Samples of why SOAP fault messages will be returned include:

  • A Group_ID is specified in the GroupIDList which does not match an existing group
  • A Group_ID is specified in one of the schedules in the ScheduleList which does not match an existing group
  • A Group_ID is specified in one of the schedules in the ScheduleList of which the participant is not a member or is not specified in GroupIDList for them to be made a member
  • Any data element that is greater than the specified maximum (as with existing QMWISe methods)
Available in:
  • Version 4.3 + To use this method you must purchase an additional license for the SAP Connector.
  • Version 5.1 +
  • Hotfix available for Version 5.2 SP1
A hotfix is available for Questionmark Perception 5.2 with Service Pack 1 that updates the WSDL for this method and provides the default values indicated below. This hotfix can be obtained by contacting Questionmark Technical Services.

Parameters

Input name   Description Default value Data type Optional field?

Participant_ID

  

The participant ID of the participant whose details are to be created/modified

 -

Integer

Y

Participant_Name

  

The login name of the participant

 -

String

N

Password

  

The login password of the participant

 -

String

Y

Authenticate_Ext

  

This indicates whether the participant must be authenticated externally. Must be 1 or 0.

Where:

1 = true

0 = false

 0

Integer

N

First_Name

  

The participant's forename

 -

String

Y

Last_Name

  

The participant's surname

 -

String

Y

Middle_Name

  

The participant's middle name(s)

 -

String

Y

Use_Correspondence

  

This indicates how email correspondence will be used. Must be 1 or 0.

Where:

1 = true

0 = false

 0

Integer

N

Primary_Address_1

  

The first line of the participant's primary address

 -

String

Y

Primary_Address_2

  

The second line of the primary address

 -

String

Y

Primary_City

 

The city or town in the primary address

 -

String

Y

Primary_State

 

The state or county in the primary address

 -

String

Y

Primary_ZIP_Code

 

The ZIP or postal code in the primary address

 -

String

Y

Primary_Country

 

The country in the primary address

 -

String

Y

Primary_Phone

 

The participant's primary telephone number

 -

String

Y

Primary_Fax

 

The participant's primary fax number

 -

String

Y

Primary_Email

 

The participant's primary email address

 -

String

Y

Secondary_Address_1

 

The participant's secondary address

 -

String

Y

Secondary_Address_2

 

 -

String

 Y

Secondary_City

 

 -

String

 Y

Secondary_State

 

 -

String

 Y

Secondary_ZIP_Code

 

 -

String

 Y

Secondary_Country

 

 -

String

 Y

Secondary_Phone

 

 -

String

 Y

Secondary_Fax

 

 -

String

 Y

Secondary_Email

 

 -

String

 Y

Salutation

 

How to address the participant

 -

String

Y

Organization_Name

 

The name of the participant's organization

 -

String

Y

Department

 

The participant's department within their organization

 -

String

Y

Title

 

The participant's title

 -

String

Y

Assistant_Name

 

The name of the participant's assistant

 -

String

Y

Manager_Name

 

The name of the participant's manager

 -

String

Y

Gender

 

The participant's gender

 -

String

Y

URL

 

A URL for the participant (such as that of a homepage or picture)

 -

String

Y

Date_Registration

 

The date the participant was registered

 -

Date

Y

Details

 

The participant's general details

 -

String

Y

Details_1 to Details_20

 

These contain specific details about the participant

 -

String

Y

GroupIDList

(may occur several times)

     -   Y
 

Group_ID

This is the group ID of the group(s) in the new schedule

 - String

Y

ScheduleList

(may occur several times)

     -

 

 Y

 

Schedule_ID

The schedule ID

 -

Integer

Y

 

Assessment_ID

The assessment ID of the assessment in the schedule

 -

Integer

Y

 

Particpant_ID

This is the participant ID of the participant in the schedule

 -

String

Y

 

Schedule_Name

This is the descriptive name of the schedule

 -

String

Y

 

Restrict_Times

This indicates whether Schedule_Starts and Schedule_Stops below are used to restrict the period for which the assessment is available. Must be 1 or 0.

Where:

1 = true

0 = false

 -

Boolean

N

 

Schedule_Starts

If Restrict_Times above is set, this is the date and time at which this schedule becomes available

 -

Date/Time

Y if Restrict_Times = 0

 

Schedule_Stops

If Restrict_Times above is set, this is the date and time at which this schedule ceases to be available

 -

Date/Time

Y if Restrict_Times = 0

 

Restrict_Attemps

This indicates whether or not to use Max_Attempts. Must be 1 or 0.

Where:

1 = true

0 = false

 -

Boolean

N

 

Max_Attempts

This is the maximum number of times the schedule can be accessed. Insert 0 for unlimited attempts. Is ignored unless Restrict_Attempts = 1

 -

Integer

N

 

Monitored

0 - Assessment in schedule not monitored

1 - Assessment in schedule monitored

 0

Boolean

N

* Only available in Version 5.1 and higher

Response

Output name   Description Data type

Participant_ID

  

The participant ID of the participant whose details are to be created/modified

Integer

Participant_Name

  

The login name of the participant

String

Password

  

The login password of the participant

String

Authenticate_Ext

  

This indicates whether the participant must be authenticated externally

Integer

First_Name

  

The participant's forename

String

Last_Name

  

The participant's surname

String

Middle_Name

  

The participant's middle name(s)

String

Use_Correspondence

  

This indicates how email correspondence will be used

Integer

Primary_Address_1

  

The first line of the participant's primary address

String

Primary_Address_2

  

The second line of the primary address

String

Primary_City

 

The city or town in the primary address

String

Primary_State

 

The state or county in the primary address

String

Primary_ZIP_Code

 

The ZIP or postal code in the primary address

String

Primary_Country

 

The country in the primary address

String

Primary_Phone

 

The participant's primary telephone number

String

Primary_Fax

 

The participant's primary fax number

String

Primary_Email

 

The participant's primary email address

String

Secondary_Address_1

 

The participant's secondary address

String

Secondary_Address_2

 

String

Secondary_City

 

String

Secondary_State

 

String

Secondary_ZIP_Code

 

String

Secondary_Country

 

String

Secondary_Phone

 

String

Secondary_Fax

 

String

Secondary_Email

 

String

Salutation

 

How to address the participant

String

Organization_Name

 

The name of the participant's organization

String

Department

 

The participant's department within their organization

String

Title

 

The participant's title

String

Assistant_Name

 

The name of the participant's assistant

String

Manager_Name

 

The name of the participant's manager

String

Gender

 

The participant's gender

String

URL

 

A URL for the participant (such as that of a homepage or picture)

String

Date_Registration

 

The date the participant was registered

Date

Details

 

The participant's general details

String

Details_1 to Details_20

 

These contain specific details about the participant

String

Group_ID

(may occur several times)

 

This is the group ID of the group(s) in the new schedule

Integer

 

Schedule_ID

The schedule ID

Integer

 

Assessment_ID

The assessment ID of the assessment in the schedule

Integer

 

Particpant_ID

This is the participant ID of the participant in the schedule

String

 

Schedule_Name

This is the descriptive name of the 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

 

session_Language*

The language the assessment should be displayed in if it has been translated

String

 

participant_Can_Choose *

Indicates if the participant can choose to take the assessment on or off-line

Boolean

 

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

 

Restrict_Attemps

This indicates whether or not to use Max_Attempts

Boolean

 

Max_Attempts

This is the maximum number of times the schedule can be accessed

Integer

 

Monitored

0 - Assessment in schedule not monitored

1 - Assessment in schedule monitored

Boolean

* Only available in Version 5.1

Troubleshooting

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

Appendix - Error codes