Preliminary report - API
  • 09 Sep 2025
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Preliminary report - API

  • Dark
    Light
  • PDF

Article summary

Get Preliminary Marking Report

Get schedule/{ScheduleExtId}/marking/preliminary-report

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

Request Parameters

Parameters indicated with a * are mandatory

ParameterTypeDescription
externalIdString(64)Schedule external id

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/schedule/{ScheduleExtId}/marking/preliminary-report

Sample successfull Response

{
    "Content": [
        {
            "ScheduleTitle": "Schedule title",
            "ScheduleExternalId": "19284712",
            "AssessmentTitle": "Assessment title",
            "AssessmentItemTitle": "Form A",
            "Title": "Schedule title",
            "Code": "123",
            "HierarchyTitle": "University Cirrus",
            "IpAddresses": "",
            "TimeSpent": "00:00:10",
            "Status": "NOT_ASSESSED",
            "LearningObjectives": [],
            "Topics": [],
            "Sections": [],
            "Questions": [
                {
                    "Question": "Essay question",
                    "SectionId": null,
                    "FunctionalId": "01002s2-1",
                    "Version": 2,
                    "Revision": 2,
                    "Answer": "Candidate Answer",
                    "Rationale": null,
                    "MarkingProgressStatus": "MARKING_FIRST_STEP_COMPLETE",
                    "MarkerEvaluations": [
                        {
                            "Name": "Jad Kaddour",
                            "Comment": null,
                            "Score": "3",
                            "CriteriaScore": [
                                {
                                    "Title": "Criterion 1",
                                    "Score": "1.5",
                                    "MaxScore": "3",
                                    "SubCriteria": [
                                        {
                                            "Title": "Sub Criterion 1-1",
                                            "Score": "0.5",
                                            "MaxScore": "1"
                                        },
                                        {
                                            "Title": "Sub Criterion 1-2",
                                            "Score": "0.5",
                                            "MaxScore": "1"
                                        },
                                        {
                                            "Title": "Sub Criterion 1-3 ",
                                            "Score": "0.5",
                                            "MaxScore": "1"
                                        }
                                    ]
                                },
                                {
                                    "Title": "Criterion 2",
                                    "Score": "1.5",
                                    "MaxScore": "3",
                                    "SubCriteria": [
                                        {
                                            "Title": "Sub Criterion 2-1 ",
                                            "Score": "0.5",
                                            "MaxScore": "1"
                                        },
                                        {
                                            "Title": "Sub Criterion 2-2",
                                            "Score": "0.5",
                                            "MaxScore": "1"
                                        },
                                        {
                                            "Title": "Sub Criterion 2-3",
                                            "Score": "0.5",
                                            "MaxScore": "1"
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "ModeratorEvaluations": [],
                    "RemarkerEvaluations": [],
                    "MaxScore": "6",
                    "FinalScore": null,
                    "PlagiarismScore": null
                }
            ],
            "ExternalId": "122074",
            "FirstName": "Candidate",
            "LastName": "Last name",
            "UserName": "candidate01",
            "Email": "candidate01@your.org"
        },
    "Success": true,
    "Errors": null
}

Response codes

CodeDescription
200Successful operation
403Not allowed to use external API
400Possible error codes:
Assessment hasn't been found by external id externalId
500Internal server error

Was this article helpful?