Patch marking settings

Get schedule info

PATCH /api/v1/integrations/external/schedule/{externalId}/marking/settings

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(60)	Schedule external id

Request Parameters (for message body)

Parameter	Type	Description
Settings	Object	Common schedule marking settings
Settings.AssessingType	Enum[String]	Possible values:TWO_ASSESSORS, ONE_ASSESSOR
Settings.AllocationType	Enum[String]	Possible values: BY_CANDIDATES, BY_QUESTIONS
Settings.AllocationAssignmentType	Enum[String]	Possible values: MANUAL, ASSESSOR_DECIDES
Settings.SharingAnnotations	Boolean	Selecting this option will allow the assessors to view each others assessments
Settings.EvaluationsSharingType	Enum[String]	Possible values: BY_ALLOCATIONS - Only if assessing same ALL - All candidates/items
Settings.AnonymousCandidates	Boolean	Selecting this option hides the name of the candidate. Only the candidate ID will be displayed
Settings.AnonymousAssessors	Boolean	Selecting this ensures that the assessors will be hidden from each other
Settings.AssessAutoScored	Boolean	SSelecting this option will allow the assessors to score auto-scored questions
Settings.UseModeration	Boolean	Selecting this option enables the use of moderation for the assessment
Settings.ShowAssessorAnnotations	Boolean	Selecting this option will allow the moderator to view annotations from the assessor(s)
Settings.ScoringDifference	Integer	Allows you to select the accepted percentage before candidate submissions goes to moderation. If NULL ScoringDifference is not used to send attempts to moderation
Settings.ProximityToPassMark	Integer	Allows you to select the accepted proximity to pass-mark before candidate submissions goes to moderation. If NULL ProximityToPassMark is not used to send attempts to moderation
Settings.PassMarkRange	Object	Allows you to select the pass-mark range when candidate submissions goes to moderation. If NULL PassMarkRange is not used to send attempts to moderation
Settings.PassMarkRange.From	Integer	Minimum score to send attempt to moderation
Settings.PassMarkRange.To	Integer	Maximum score to send attempt to moderation
Settings.SampleModeration	Integer	Allows you to select percent of candidates/questions that will definitely go to moderation. If NULL this rule won't be used. Max value: 1, Min value: 100
Assessors	Array[Object]	List of assessors
Assessors[].Action	Enum[String]?	Possible values: UPSERT - Add or update assessor DELETE - Delete existing assessor
Assessors[].ExternalId	String	Candidate external ID (userid)
Assessors[].FirstName	String	Assessor first name
Assessors[].LastName	String	Assessor last name
Assessors[].UserName	Boolean	Assessor username
Assessors[].Password	String	Password, if null or empty it will be generated automatically
Assessors[].Role	Enum[String]	Possible values: ASSESSOR, MODERATOR, ASSESSOR_AND_MODERATOR, OTHER
Assessors[].CanPublish	Boolean	Assessor can publish submitted attempts
Assessors[].CanViewAudit	Boolean	Assessor can view audit
Assessors[].CanEditMarkingScheme	Boolean	Assessor can edit marking scheme
Assessors[].AddressLine1	String	Address one
Assessors[].AddressLine2	String	Address two
Assessors[].Phone	Boolean	Phone number
Assessors[].Company	String	Company
Assessors[].City	Boolean	City
Assessors[].CountryCode	String	CountryCode
Assessors[].PostalCode	String	PostalCode
Assessors[].PostalAddress	String	PostalAddress
Assessors[].SpecialNeeds	Boolean	SpecialNeeds
Assessors[].Photo	String	Link to download profile image
Allocations	Array[Object]	Matrix of allocations
Allocations[].ExternalId	String	Candidate or question external ID. It depends on Settings.AllocationType
Allocations[].Markers	Array[String]	Marker external IDs
Allocations[].Moderator	String	Moderator external ID

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/external/schedule/schid_1/marking/settings

Sample successfull Response

{
    "Content": {
        "ScheduleTitle": "Test Schedule for Marking",
        "MarkingWorkflow": "SIMPLE",
        "Archived": true,
        "Questions": [
            {
                "ExternalId": "19655-2",
                "Type": "FILE_RESPONSE",
                "QuestionText": "File response question1"
            },
            {
                "ExternalId": "87454-2",
                "Type": "FILE_RESPONSE",
                "QuestionText": "File response question2"
            }
        ],
        "Candidates": [
            {
                "ExternalId": "7131",
                "FirstName": "testuser1",
                "LastName": "testuser1",
                "UserName": "testuser1"
            },
            {
                "ExternalId": "7140",
                "FirstName": "testuser10",
                "LastName": "testuser10",
                "UserName": "testuser10"
            },
            {
                "ExternalId": "7141",
                "FirstName": "testuser11",
                "LastName": "testuser11",
                "UserName": "testuser11"
            }
        ],
        "Settings": {
            "AssessingType": "ONE_ASSESSOR",
            "AllocationType": "BY_CANDIDATES",
            "AllocationAssigmentType": "MANUAL",
            "SharingAnnotations": false,
            "EvaluationsSharingType": "BY_ALLOCATIONS",
            "AnonymousCandidates": false,
            "AnonymousAssessors": false,
            "AssessAutoScored": false,
            "UseModeration": false,
            "ShowAssessorAnnotations": false,
            "ScoringDifference": "10",
            "ProximityToPassMark": "2",
            "SampleModeration": "10",
            "PassMarkRange": null
        },
        "Assessors": [
            {
                "Role": "ASSESSOR",
                "CanPublish": true,
                "CanViewAudit": true,
                "CanEditMarkingScheme": false,
                "DirectLink": "/#external-login?session=XFIkuM112eeHtwmlTpieo3oBD59rmK0jT5kqskj1uriMHw0eIGlaHLW3Rk1iQfk2",
                "ExternalId": "41023018",
                "FirstName": "John",
                "LastName": "Brown",
                "UserName": "assessor1"
            }
        ],
        "Allocations": [
            {
                "ExternalId": "7131",
                "Markers": [
                    "41023018"
                ],
                "Moderator": null
            },
            {
                "ExternalId": "7140",
                "Markers": [
                    "41023018"
                ],
                "Moderator": null
            },
            {
                "ExternalId": "7141",
                "Markers": [
                    "41023018"
                ],
                "Moderator": null
            }
        ]
    },
    "Success": true,
    "Errors": null
}

Responses

Code	Description
200	Successful operation
403	Not allowed to use external API
400	Possible error codes: 102: Unknown error 300: ScheduleExternalId can not be null or empty 301: Schedule has not been found 303: Schedule is not activated 308: Schedule does not support marking 309: Marking settings is not found 600: Marking settings is not found 601: AssessingType has invalid value 602: AllocationType has invalid value 603: Difference has invalid value 604: Proximity has invalid value 605: PassMarkRange has invalid value 606: Anonymous assessors must be FALSE for one assessor 607: Invalid moderation settings for two assessors: at least one of the fields(Proximity, Difference, PassMarkRange) must be specify 608: Invalid moderation settings for one assessors: at least one of the fields(Proximity, PassMarkRange) must be specify 609: Impossible to change evaluation settings for exams with published results 610: Impossible to change evaluation settings for finished exams 611: EvaluationsSharingType has invalid value 618: SampleModeration has invalid value
500	Internal server error