This endpoint allows to record data about students, teachers ou members related to an school.

To differentiate any person from each other, use the attribute role under roles collection.

Types of roles

  • LEARNER: Represents a student
  • INSTRUCTOR: Represents a teacher
  • MENTOR: Represents a educational coordinator or someone that leads educational department
  • MANAGER: Represents a person acting as a school manager
  • GUARDIAN: Represents the student's parent or guardian

Endpoints

Endpoint for production environment
POST [under construction / not available]

Endpoint for sandbox
POST https://x3b54mm4ze.execute-api.us-east-1.amazonaws.com/test/person

Request structure

Header

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

Body
Json in Caliper API format containing person information.

Required Fields

  • All fields are required

Payload example

{
  "@context": "http://purl.imsglobal.org/ctx/caliper/v1p2",
  "id": "https://example.edu/terms/201601/courses/7/sections/1/rosters/1/members/554433",
  "type": "Membership",
  "member": {
    "id": "https://example.edu/users/554433",
    "type": "Person"
  },
  "organization": {
    "id": "https://example.edu/terms/201601/courses/7/sections/1",
    "type": "CourseSection",
    "subOrganizationOf": {
      "id": "https://example.edu/terms/201601/courses/7",
      "type": "CourseOffering"
    }
  },
  "roles": [ "Learner" ],
  "status": "Active",
  "dateCreated": "2016-11-01T06:00:00.000Z"
}

Responses

  • Code: 200
    • Status: OK
{
    "message": "Person recorded successfuly"
}
  • 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!