This access point records data regarding the completion of a reading by a student.

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.host : Edtech URL
  • object.assignee : Identifies the student who is performing the task (data obteined from HUB)
  • object.assignable.id : Identifies the performed task
  • object.assignable.skillCode : Common National Curriculum Base identification code. See more in http://basenacionalcomum.mec.gov.br/
  • object.assignable.isPartOf.id : Identifies the subject of the performed task
  • object.dateCreated : Date on which tha data was sent to Learning Analytics
  • object.startedAtTime : Date on which the task was started
  • object.duration: : Task duration in seconds
  • object.finished: : Boolean data indicating whether the task has ended
  • object.edApp: : Edtech UUID retrieved from Hub platform
  • generated.scoreGiven: : Grade assigned to the student reporting the completion of the task
  • generated.hits: : Number of student attempts to complete the task

Payload structure

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
  "type": "GradeEvent",
  "profile": "GradingProfile",
  "actor": {
    "type": "SoftwareApplication",
    "host":<<Edtech URL string>>
  },
  "action": "Graded",
  "object": {
    "type": "Attempt",
    "assignee": {
      "id": "urn:uuid:<<StudentId>>",
      "type": "Person"
    },
    "assignable": {
      "id": <<ActivityId>>,
      "type": "Activity",
      "skillCode": <<bncc_skill_code>>
      "isPartOf": {
        "id": <<SubjectId>>,
        "type": "Subject"
      }
    },
    "dateCreated":<<Date_Time_Now>>,
    "startedAtTime":<<StartedTime>>,
    "duration":<<TotalSeconds>>,
    "finished":<<Finished>>
  },
  "edApp": "urn:uuid:<<Edtech uuid on Positivo`s hub platform>>",
  "generated": {
    "type": "Score",
    "maxScore": 100.0,
    "scoreGiven": <<Performance>>,
    "hits": <<Hits>>
  }
}

Responses

  • Code: 200
    • Status: OK
{
"@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
"id": "urn:uuid:6bbab0d2-11de-4bcf-8004-a380d3d485ab"
}
  • 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!