Contents x
    Patch marking settings
    • 30 Jun 2021
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Patch marking settings

    • Updated on 30 Jun 2021
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get schedule info

    PATCH /api/v1/integrations/external/schedule/{externalId}/marking/settings
    NameData TypeDescription
    Content-type:application/jsonfor all requests
    Authorization:EAPI {token}for all requests

    Request Parameters

    Parameters indicated with a * are mandatory

    ParameterTypeDescription
    externalIdString(60)Schedule external id

    Request Parameters (for message body)

    ParameterTypeDescription
    SettingsObjectCommon schedule marking settings
    Settings.AssessingTypeEnum[String]Possible values:TWO_ASSESSORS, ONE_ASSESSOR
    Settings.AllocationTypeEnum[String]Possible values: BY_CANDIDATES, BY_QUESTIONS
    Settings.AllocationAssignmentTypeEnum[String]Possible values: MANUAL, ASSESSOR_DECIDES
    Settings.SharingAnnotationsBooleanSelecting this option will allow the assessors to view each others assessments
    Settings.EvaluationsSharingTypeEnum[String]Possible values:
    BY_ALLOCATIONS - Only if assessing same
    ALL - All candidates/items
    Settings.AnonymousCandidatesBooleanSelecting this option hides the name of the candidate. Only the candidate ID will be displayed
    Settings.AnonymousAssessorsBooleanSelecting this ensures that the assessors will be hidden from each other
    Settings.AssessAutoScoredBooleanSSelecting this option will allow the assessors to score auto-scored questions
    Settings.UseModerationBooleanSelecting this option enables the use of moderation for the assessment
    Settings.ShowAssessorAnnotationsBooleanSelecting this option will allow the moderator to view annotations from the assessor(s)
    Settings.ScoringDifferenceIntegerAllows you to select the accepted percentage before candidate submissions goes to moderation. If NULL ScoringDifference is not used to send attempts to moderation
    Settings.ProximityToPassMarkIntegerAllows 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.PassMarkRangeObjectAllows 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.FromIntegerMinimum score to send attempt to moderation
    Settings.PassMarkRange.ToIntegerMaximum score to send attempt to moderation
    Settings.SampleModerationIntegerAllows 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
    AssessorsArray[Object]List of assessors
    Assessors[].ActionEnum[String]?Possible values:
    UPSERT - Add or update assessor
    DELETE - Delete existing assessor
    Assessors[].ExternalIdStringCandidate external ID (userid)
    Assessors[].FirstNameStringAssessor first name
    Assessors[].LastNameStringAssessor last name
    Assessors[].UserNameBooleanAssessor username
    Assessors[].PasswordStringPassword, if null or empty it will be generated automatically
    Assessors[].RoleEnum[String]Possible values: ASSESSOR, MODERATOR, ASSESSOR_AND_MODERATOR, OTHER
    Assessors[].CanPublishBooleanAssessor can publish submitted attempts
    Assessors[].CanViewAuditBooleanAssessor can view audit
    Assessors[].CanEditMarkingSchemeBooleanAssessor can edit marking scheme
    Assessors[].AddressLine1StringAddress one
    Assessors[].AddressLine2StringAddress two
    Assessors[].PhoneBooleanPhone number
    Assessors[].CompanyStringCompany
    Assessors[].CityBooleanCity
    Assessors[].CountryCodeStringCountryCode
    Assessors[].PostalCodeStringPostalCode
    Assessors[].PostalAddressStringPostalAddress
    Assessors[].SpecialNeedsBooleanSpecialNeeds
    Assessors[].PhotoStringLink to download profile image
    AllocationsArray[Object]Matrix of allocations
    Allocations[].ExternalIdStringCandidate or question external ID. It depends on Settings.AllocationType
    Allocations[].MarkersArray[String]Marker external IDs
    Allocations[].ModeratorStringModerator 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

    CodeDescription
    200Successful operation
    403Not allowed to use external API
    400Possible 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
    500Internal server error
    Was this article helpful?
    What's Next