Reading and Grading event

This endpoint records data related to the completion of a reading activity and assigning a grade to the student.

Request structure

Header

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

Body
Json in Caliper API format containing student, subject, activyty and grade information.

{
    "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
    "id": "urn:uuid:12c05c4e-253f-4073-9f29-5786f3ff3f36",
    "type": "ViewGradeEvent",
    "profile": "ReadingGradingProfile",
    "actor": {
        "type": "SoftwareApplication",
        "host": <STRING>
    },
    "action": "ViewedGraded",
    "object": {
        "type": "Reading/Listen",
        "assignee": {
            "id": "urn:uuid:<<UUID>>",
            "type": "Person"
        },
        "assignable": {
            "id": <INTEGER>,
            "type": <STRING>,
            "skillCode": <STRING>,
            "extension": {
                "name": <STRING>,
                "bookLevel": <STRING>
            },
            "isPartOf": {
                "id": 1,
                "name": <STRING>,
                "type": "Subject"
            },
      			"frequency_assigned":<INTEGER>
        },
        "dateCreated": <ISO 8601 DATETIME>,
        "startedAtTime": <ISO 8601 DATETIME>,
        "duration": <FLOAT>
    },
    "edApp": "urn:uuid:<<UUID>>",
    "generated": {
        "type": "Score",
        "maxScore": <FLOAT>,
        "scoreGiven": <FLOAT>
    }
}

Required Fields

Field	Content description	Accepeted values	Required
@context		Defaut value as in the payload body description	yes
Id		Defaut value as in the payload body description	yes
type	Indicates the event that originated the data.	GradeEvent, ViewEvent, GradeViewEvent	yes
profile	Indicates the type of event related to the structure of the data representing the event.	GradingProfile, ReadingProfile, ReadingGradingProfile	yes
actor.type	Identifies the system where the event occurs.		yes
actor.host	URL to the system where the event occurs.		yes
action	Type 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.type	Type of action being recorded by the event.	Attempt, Reading, Reading/Listen	yes
object.assignee.id	Identifier code of the student in the Hub platform, in URN format and UUID type.		yes
object.assignee.type	Identifies the type of assignee.	Person (default)	yes
object.assignable.id	Activity code related to the event in the source system.		yes
object.assignable.type	Type of activity performed by the student.	Activity, Book Activity	yes
object.assignable.skillCode	Skill code according to the BNCC (National Common Curricular Base).		yes
object.assignable.extension.name	Title of the activity performed by the student. Optional.		no
object.assignable. extension.bookLevel	Complexity level of the activity performed by the student. Optional.		no
object.assignable.isPartOf.id	Discipline code according to MEC (Ministry of Education and Culture).		no
object.assignable.isPartOf.name	Name of the discipline in the source system of the event.		no
object.assignable.isPartOf.type	Type of element related to the discipline of the activity performed by the student.	Subject (default), GroupStudy, Task	no
object.assignable.frequency_assigned	Informs the frequency assigned for tasks to be attended by students.	1 (default)	no
object.dateCreated	Creation date of the record. Format: ISO 8601.	Current date	yes
object.startedAtTime	Date on which the student started the activity. Format: ISO 8601.		yes
object.endedAtTime	Date on which the student completed the activity. Format: ISO 8601.		no
object.lastTime	Date on which the student last accessed the activity. Format: ISO 8601.		no
object.totalTime	Time consumed to complete the activity in seconds.		yes
object.percentReading	Percentage of completion of reading a book.		no
object.completionType	Indicates whether the activity was successfully completed or not.	SUCCESSFULL, FAILURE, ONGOING, EXTRA, CANCEL	no
object.finished	Indicates whether the activity or reading was fully completed.	TRUE, FALSE	no
edApp	Identifier code of the edtech in the Hub platform, in URN format and UUID type.		yes
generated.type	Type of result assignment for the activity performed by the student.	Score	no
generated.maxScore	Maximum grade that can be assigned to the activity performed by the student.		no
generated.scoreGiven	Score assigned to the activity performed by the student.		no
generated.proficiencyLevel	Proficiency level related to the student's performance in completing the activities.		no
generated.trys	Number of attempts to perform the activity.		no

Responses

Code: 200
- Status: OK

{
"@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
"id": "urn:uuid:<<UUID>>"
}

Code: 400
- Status: Bad Request

{
    "message": [
          "Field <fieldname> not informed"
    ]
}