This endoint should be used by every edtech that wants to integrate into the Learning Analitys system. This is the recording of data related to the execution of activities, with the attribution of a numerical note or categorical concepts and, optionally, informing titles of readings as well as identifying the skills according to the Base Nacional Comum Curricula of the Brazilian Ministry of Culture and Education.

This endpoint records data related to the completion of an activity, assigning a numerical grade according to the student's performance.

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.

 {
    "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
    "id": "urn:uuid:12c05c4e-253f-4073-9f29-5786f3ff3f36",
    "type": "GradeEvent",
    "profile": "GradingProfile",
    "actor": {
        "type": "SoftwareApplication",
        "host": <STRIN: URL>
    },
    "action": <STRING>,
    "object": {
        "type": <STRING>,
        "assignee": {
            "id": "urn:uuid:<<    >>",
            "type": "Person"
        },
        "assignable": {
            "id": <STRING>,
            "type": <STRING>,
            "skillCode": <STRING>,
            "extension": {
                "name": <STRING>
                "bookLevel": <STRING>
            },
            "isPartOf": {
                "id": 6,
                "name": "<STRING>",
                "type": "Subject"
            },
						"frequency_assigned": <INTEGER>
        },
        "dateCreated": <DATE TIME>,
        "startedAtTime": <DATE TIME>,
        "endedAtTime": <DATE TIME>,
        "lastTime": "2022-07-19T19:36:12.117",
        "totalTime": <INT>,
        "percentReading": 25.91
        "completionType": <STRING>
        "finished": "True"
    },
    "edApp": "urn:uuid:<<   >>",
    "generated": {
        "type": <STRING>,
        "maxScore": <FLOAT>,
        "scoreGiven": <FLOAT>,
        "proficiencyLevel": <STRING>,
        "trys": <INT>
    }
}

Required Fields

FieldContent descriptionAccepeted valuesRequired
@context Defaut value as in the payload body descriptionyes
IdDefaut value as in the payload body descriptionyes
typeIndicates the event that originated the data.GradeEvent,
ViewEvent,
GradeViewEvent
yes
profileIndicates the type of event related to the structure of the data representing the event.GradingProfile,
ReadingProfile,
ReadingGradingProfile
yes
actor.typeIdentifies the system where the event occurs.yes
actor.hostURL to the system where the event occurs.yes
actionType of action being recorded in the event. For this API, actions are related to the completion of a learning object.Viewed.
Graded,
ViewdGraded
yes
object.typeType of action being recorded by the event.Attempt,
Reading,
Reading/Listen
yes
object.assignee.idIdentifier code of the student in the Hub platform, in URN format and UUID type.yes
object.assignee.typeIdentifies the type of assignee.Person (default)yes
object.assignable.idActivity code related to the event in the source system.yes
object.assignable.typeType of activity performed by the student.Activity,
Book Activity
yes
object.assignable.skillCodeSkill code according to the BNCC (National Common Curricular Base).yes
object.assignable.extension.nameTitle of the activity performed by the student. Optional.no
object.assignable. extension.bookLevelComplexity level of the activity performed by the student. Optional.no
object.assignable.isPartOf.idDiscipline code according to MEC (Ministry of Education and Culture).no
object.assignable.isPartOf.nameName of the discipline in the source system of the event.no
object.assignable.isPartOf.typeType of element related to the discipline of the activity performed by the student. Default.Subject (default),
GroupStudy,
Task
no
object.assignable.frequency_assignedInforms the frequency assigned for tasks to be attended by students.1 (default)no
object.dateCreatedCreation date of the record. Format: ISO 8601.Current dateyes
object.startedAtTimeDate on which the student started the activity. Format: ISO 8601.yes
object.endedAtTimeDate on which the student completed the activity. Format: ISO 8601.no
object.lastTimeDate on which the student last accessed the activity. Format: ISO 8601.no
object.totalTimeTime consumed to complete the activity in seconds.yes
object.percentReadingPercentage of completion of reading a book.no
object.completionTypeIndicates whether the activity was successfully completed or not.SUCCESSFULL,
FAILURE,
ONGOING,
EXTRA,
CANCEL
no
object.finishedIndicates whether the activity or reading was fully completed.TRUE,
FALSE
no
edAppIdentifier code of the edtech in the Hub platform, in URN format and UUID type.yes
generated.typeType of result assignment for the activity performed by the student.Scoreno
generated.maxScoreMaximum grade that can be assigned to the activity performed by the student.no
generated.scoreGivenScore assigned to the activity performed by the student.no
generated.proficiencyLevelProficiency level related to the student's performance in completing the activities.no
generated.trysNumber of attempts to perform the activity.no

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
Authorization
OAuth2
Authenticate
Click Try It! to start a request and see the response here!