GetAssessmentTreeByAdministrator | Questionmark

GetAssessmentTreeByAdministrator

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

This method returns a list of assessments by folder for a specific user. This method can be used to offer a list of folders and (successively) assessments to the user. Instead of returning the whole tree structure, the method can return only the assessment folders or assessments belonging to a specified folder ID.

Available in:
  • Version 4.2 +
  • Version 5.1 +

Parameter

Input name Description Data type Optional field?

Administrator_ID

The administrator ID of the administrator to retrieve the list for.

String

N

Parent_ID

The parent folder to retrieve items from (or 0 to retrieve top-level assessment folders)

String

N

OnlyRunFromIntegration

0 - Return all items

1 - Return only the items allowed to run from integration

Integer

N

Response

Output name   Description Data type

AssessmentTreeItemList

 

 

 

 

ID

The ID of the item

String

 

Type

0 - Assessment folder

1 - Assessment

Integer

 

Name

Item name

String

 

Parent_ID

The ID of the parent node. The parent ID is specified in the method call, but may be necessary for the calling application.

String

Troubleshooting

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

Appendix - Error codes