CheckWare partner API reference guide

Webservice operations

OverviewDatatypesWebservice operationsChangelog

addAssessmentPlanInstance

Add a new plan instance. Only plans with flag manual and enabled set to true can be used. Only plans which the API can access can be used. When access restrictions on plans are used, make sure the API user can access these plans.

Input

addAssessmentPlanInstanceRequest
PartTypeDescription
addAssessmentPlanInstanceRequestassessmentPlanInstanceThe object must specify the respondent and plan template for the instance.
Plan instance ID must be empty for this operation.

Output

addAssessmentPlanInstanceResponse
PartTypeDescription
addAssessmentPlanInstanceResponseassessmentPlanInstanceIDThe id of the new plan instance