This endpoint records a school in the Learning Analitycs Data Lake for further data analysis.

Endpoints

Production environment
POST [under construction / not available]

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

Request structure

Header

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

Body
Json in Caliper API format containing school information.

Required Fields

  • id : Unique identifier for the school
  • type : Organization (determines that it means a school)
  • name : Name of the school

Payload example

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
  "id": "https://example.edu/colleges/1/depts/1",
  "type": "Organization",
  "name": "Computer Science Department",
  "subOrganizationOf": {
    "id": "https://example.edu/colleges/1",
    "type": "Organization",
    "name": "College of Engineering",
     "term": “xxxxx”
  }
}

Responses

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