Create Assessment

Article summary

Did you find this summary helpful?

Thank you for your feedback

Assessment

POST /assessment

Name	Data Type	Description
Content-type:	application/json	for all requests
Authorization:	EAPI {token}	for all requests

Parameters indicated with a * are mandatory

Name	Data Type	Description
ExternalId	string (64)	External Id. Should be unique. Alpha-Numeric. Autogenerated by default.
Title*	string (100)	Assessment title
Purpose*	integer	Assessment purpose Possible values: 1 - Summative 2 - Formative 3 - Mixed
Code*	string (100)	Assessment code
Owner	string (64)	Assessment owner UserName. This field overrides Assessment owner from External API settings of Cirrus app. (Owner must be set in settings or in this field)

https://api.cirrusplatform.com/api/v1/integrations/assessment

{
     "Title": "External assessment",
     "ExternalId": "Ext_a_2",
     "Purpose": 3,
     "Code": "ext_assessment_2"
}

{
    "Content": "Ext_a_2",
    "Success": true,
    "Errors": null
}

Code	Description
200	Successful operation
403	Not allowed to use external API
400	Possible error codes: Assessment info is not valid Assessment must be published Assessment creator hasn’t been set in External API settings Selected assessment owner no longer has permission to create assessments The specified condition was not met for “Purpose” External id [ExternalId] is already in use 'External Id' should not be empty. 'Code' should not be empty. 'Purpose' should not be empty. 'Title' should not be empty. Assessment owner does not exist in the system Internal server error
500	Internal server error

Was this article helpful?

Table of contents