This endpoint records grade or performance as a student completes an assignment

Endpoints

Production environment
POST [under construction / not available]

Sandbox
POST https://x3b54mm4ze.execute-api.us-east-1.amazonaws.com/test/grade

Request structure

Header

  • Authorization : Access Token provided by the Request Token endpoint
  • Content-Type : application/json

Body
Json in Caliper API format containing grade information.

Required Fields

  • actor : Identifies the student who is performing the task
  • action : Default value Graded
  • object : Identifies the learning object to which the task relates

Payload example

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
  "id": "urn:uuid:12c05c4e-253f-4073-9f29-5786f3ff3f36",
  "type": "GradeEvent",
  "profile": "GradingProfile",
  "actor": {
    "id": "https://example.edu/autograder",
    "type": "SoftwareApplication",
    "version": "v2"
  },
  "action": "Graded",
  "object": {
    "id": "https://example.edu/terms/201601/courses/7/sections/1/assess/1/items/3/users/554433/attempts/1",
    "type": "Attempt",
    "assignee": {
      "id": "https://example.edu/users/554433",
      "type": "Person"
    },
    "assignable": {
      "id": "https://example.edu/terms/201601/courses/7/sections/1/assess/1/items/3",
      "type": "AssessmentItem",
      "name": "Assessment Item 3",
      "isPartOf": {
        "id": "https://example.edu/terms/201601/courses/7/sections/1/assess/1",
        "type": "Assessment"
      }
    },
    "isPartOf": "https://example.edu/terms/201601/courses/7/sections/1/assess/1/users/554433/attempts/1",
    "count": 1,
    "dateCreated": "2016-11-15T10:15:02.000Z",
    "startedAtTime": "2016-11-15T10:15:02.000Z",
    "endedAtTime": "2016-11-15T10:15:12.000Z"
  },
  "eventTime": "2016-11-15T10:57:06.000Z",
  "edApp": "https://example.edu",
  "generated": {
    "id": "https://example.edu/terms/201601/courses/7/sections/1/assess/1/items/3/users/554433/attempts/1/scores/1",
    "type": "Score",
    "attempt": "https://example.edu/terms/201601/courses/7/sections/1/assess/1/users/554433/attempts/1",
    "maxScore": 5.0,
    "scoreGiven": 5.0,
    "scoredBy": "https://example.edu/autograder",
    "comment": "auto-graded exam",
    "dateCreated": "2016-11-15T10:55:05.000Z"
  },
  "group": {
    "id": "https://example.edu/terms/201601/courses/7/sections/1",
    "type": "CourseSection",
    "courseNumber": "CPS 435-01",
    "academicSession": "Fall 2016"
  }
}

Responses

  • Code: 200
    • Status: OK
{
    "message": "Grade recorded successfuly"
}
  • Code: 400
    • Status: Bad Request
{
    "message": [
           "Field <fieldname> not informed"
    ]
}
Language
Authentication
OAuth2
Authenticate
Click Try It! to start a request and see the response here!