Assign Activity or Group Study

This endpoint records data related to the assigning of activities or group studies for classes or students.

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",
   "type":"AssignableEvent",
   "profile":"AssignableProfile",
   "actor":{
      "id":"urn:uuid:bf774164-c426-11EC-8A25-064673C470A6",
      "type":"Person"
   },
   "action":"Activated/Deactivated",
   "object":{
      "id":<STRING>,
      "type":"Activity/GroupStudy",
      "name":<STRING>,
      "dateCreated":<DATE TIME>,
      "dateModified":<DATE TIME>,
      "dateToStartOn":<DATE TIME>,
      "dateToSubmit":<DATE TIME>,
      "activities": <INTEGER>
   },
   "eventTime":<DATE TIME>,
   "edApp":<STRING>,
   "group":{
      "id":<STRING>,
      "type":<STRING>,
      "courseNumber":<STRING>,
      "academicSession":<STRING>,
      "Students": <INTEGER>
   }
}

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.	AssignableEvent	yes
profile	Indicates the type of event related to the structure of the data representing the event.	AssignableProfile	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 activation or deactivation of a learning object.	Activated, Deactivated	yes
object.id	Identifier code for the Learning Object		yes
object.type	Type of learning object being assigned.	Activity, GroupStudy	yes
object.name	Title of the learning object		yes
object.dateCreated	Date Time of assignment.		yes
object.dateModified	Date Time of modifications of the learning object	[Optional]	no
object.dateToStartOn	Date when students must start taking the learning object.	[Optional]	no
object.dateToSubmit	Due date for students taks submission.	[Optional]	no
object.activities	Total (number of) activities assigned to the class.		yes
edApp	Identifier code of the edtech in the Hub platform, in URN format and UUID type.		yes
group.id	uuid for the school		yes
group.type	Type of the assigned object	[Optional]	no
group.courseNumber	UUID for the class to witch the learning object is beeing assigned.		yes
group.academicSession	Leave empty		no
group.students	Informs the total number os students enrolled in the class.		yes
generated.type	Type of result assignment for the activity performed by the student.	Score	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"
    ]
}