Preliminary report - API
- 12 Aug 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Preliminary report - API
- Updated on 12 Aug 2025
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get Preliminary Marking Report
Get schedule/{ScheduleExtId}/marking/preliminary-report
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Request Parameters
Parameters indicated with a * are mandatory
| Parameter | Type | Description |
|---|---|---|
| externalId | String(64) | Schedule external id |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| Content | String | Schedule content |
| Content.ScheduleTitle | String | Schedule title |
| Content.ScheduleExternalId | String | Schedule external id |
| Content.AssessmentTitle | String | Assessment title |
| Content.AssessmentItemTitle | String | Assessment Form title |
| Content.title | String | Schedule title |
| Content.Code | String | Schedule code |
| Content.HierarchyTitle | String | Schedule hierarchy info |
| Content.IpAddresses | ||
| Content.TimeSpent | Integer | Timespent per candidate |
| Content.Status | ||
| Content.LearningObjectives | ||
| Content.Topics | string | Title of connection |
| Content.Sections | ||
| Content.Questions | ||
| Content.Questions.Question | ||
| Content.Questions.SectionId | ||
| Content.Questions.FunctionalId | ||
| Content.Questions.Version | ||
| Content.Questions.Revision | ||
| Content.Questions.Answer | ||
| Content.Questions.Rationale | ||
| Content.Questions.MarkingProgressStatus | ||
| Content.Questions.MarkerEvaluations | ||
| Content.Questions.MarkerEvaluations.Name | ||
| Content.Questions.MarkerEvaluations.Comment | ||
| Content.Questions.MarkerEvaluations.Score | ||
| Content.Questions.MarkerEvaluations.CriteriaScore | ||
| Content.Questions.MarkerEvaluations.CriteriaScore.Title | ||
| Content.Questions.MarkerEvaluations.CriteriaScore.Score | ||
| Content.Questions.MarkerEvaluations.CriteriaScore.MaxScore | ||
| Content.Questions.MarkerEvaluations.CriteriaScore.SubCriteria | ||
| Content.Questions.MarkerEvaluations.CriteriaScore.Title | ||
| Content.Questions.MarkerEvaluations.CriteriaScore.Score | ||
| Content.Questions.MarkerEvaluations.CriteriaScore.MaxScore | ||
| Content.Questions.ModeratorEvaluations | ||
| Content.Questions.RemarkerEvaluations | ||
| Content.Questions.MaxScore | ||
| Content.ExternalId | ||
| Content.FirstName | ||
| Content.LastName | ||
| Content.UserName | ||
| Content.Email | ||
| Success | ||
| Errors |
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
| Code | Description |
|---|---|
| 200 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible error codes: Assessment hasn't been found by external id externalId |
| 500 | Internal server error |
Was this article helpful?
