Contents x
    Get Available Assessments
    • 22 Dec 2021
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get Available Assessments

    • Updated on 22 Dec 2021
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get Assessment

    Result of Get Assessment call

    This call will get all assessments with an external ID, that have a status Live and Published.

    Get /assessments/
    NameData TypeDescription
    Content-type:application/jsonfor all requests
    Authorization:EAPI {token}for all requests

    Request Parameters

    Parameters indicated with a * are mandatory

    ParameterTypeDescription
    purposesString(50)Filter of assessments by purposes, It is used as the get parameter of request, For example “?purposes=1” will return all Summative assessments, “?purposes=1,2” will return all Summative and Formative assessments
    Possible options:
    Summative=1
    Formative=2
    Mixed=3

    Sample Request URL

    https://api.cirrusplatform.com/api/v1/integrations/assessments?purposes=1,2

    Sample successfull Response

    [
  {
    "ExtId": "MB0-001",
    "Title": "Exam 1",
    "Purpose": 1,
    "AttemptDuration": 90,
    "AllowedNumberOfAttempts": 1
  },
  {
    "ExtId": "MB0-00123",
    "Title": "Exam 2",
    "Purpose": 2,
    "AttemptDuration": 90,
    "AllowedNumberOfAttempts": null
  }
]

    Responses

    CodeDescription
    200Successful operation
    Was this article helpful?
    What's Next