student.md

Student

Represents a student.

Properties

Domain specific

• number - Student number.
  • mandatory
  • non editable
  • type: number
  • example: 90654
• name - Student name.
  • mandatory
  • editable
  • type: Date
  • possible values: Jumberto Silva
• tId - Team id.
  • mandatory
  • non editable
  • type: number
  • example: 8
• cId - Class id.
  • mandatory
  • editable
  • type: Date
  • possible values: 5

Media-type Siren

• class
• properties
• entities
• links
• actions

Standard

• item
• rel

Link Relations

Domain Specific

• Classroom
• Home page
• logout

Standard - IANA

• self
• next
• prev

Actions

• List Students - Classroom
• List Students - Team
• Get Students - Student
• Get Students - Teacher

---

Success Responses

List Students Classroom

List all the students of a classroom.

GET api/orgs/{orgId}/classrooms/{classId}/students

Status:  200 OK

{
  "class": [ "students", "collection" ],
  "properties": {
    "pageIndex": 0,
    "pageSize": 1
  },
  "entities": [
    {
      "class": [ "student" ],
      "rel": [ "item" ],
      "properties": {
        "number": "82264",
        "name": "Xhang-Chi"
      },
      "links": [
        {
          "rel": ["self"],
          "href": "api/orgs/3/classrooms/4/students/82264"
        },
      ]
    }
  ],
  "links": [
    {
      "rel": ["self"],
      "href": "api/orgs/3/classrooms/4/students"
    },
    {
      "rel": ["next"],
      "href": "api/orgs/3/classrooms/4/students?page=1&limit=10"
    },
    {
      "rel": ["prev"],
      "href": "api/orgs/3/classrooms/4/students?page=1&limit=10"
    },
    {
      "rel": ["home"],
      "href": "/api"
    },
    {
      "rel": ["logout"],
      "href": "/api/logout"
    },
    {
      "rel": ["classroom"],
      "href": "api/orgs/3/classrooms/4"
    }
  ]
}

List Students team

List all the students of a team.

GET api/orgs/{orgId}/classrooms/{classId}/teams/{teamId}/students

Status:  200 OK

{
  "class": [ "students", "collection" ],
  "properties": {
    "pageIndex": 0,
    "pageSize": 1
  },
  "entities": [
    {
      "class": [ "students" ],
      "rel": [ "item" ],
      "properties": {
        "number": "82264",
        "name": "Xhang-Chi"
      },
      "links": [
        {
      "rel": ["self"],
      "href": "api/orgs/3/classrooms/4/teams/5/students/82264"
    },
      ]
    }
  ],
  "links": [
    {
      "rel": ["self"],
      "href": "api/orgs/3/classrooms/4/teams/5/students"
    },
    {
      "rel": ["next"],
      "href": "api/orgs/3/classrooms/4/teams/5/students?page=1&limit=10"
    },
    {
      "rel": ["prev"],
      "href": "api/orgs/3/classrooms/4/teams/5/students?page=1&limit=10"
    },
    {
      "rel": ["home"],
      "href": "/api"
    },
    {
      "rel": ["logout"],
      "href": "/api/logout"
    },
    {
      "rel": ["team"],
      "href": "api/orgs/3/classrooms/4/team/5"
    }
  ]
}

Get Student - Student

Student view of a Get Student request.

GET api/orgs/{orgId}/classrooms/{classId}/teams/{teamId}/students{number}

Status:  200 OK

{
  "class": [ "student" ],
  "properties": {
      "number": 977,
      "name": "Julio Lourenço"
  },
  "entities": {
      "class": [ "team" ],
      "rel": [ "item" ],
      "properties": {
        "id": 12,
        "name": "team1",
        "state": "active"
      },
      "links": [
        {
          "rel": ["self"],
          "href": "/api/orgs/852/classrooms/456/teams/123"
        }
      ]
    },
    "actions": [
      {
        "name": "update-student",
        "title": "Update Student",
        "method": "PUT",
        "href": "/api/orgs/{orgId}/classrooms/{classId}/teams/123/students/977",
        "type": "application/json",
        "field": [
          {"name": "name", "type": "string"}
        ]
      }
    ],
  "links": [
    {
      "rel": ["self"],
      "href": "/api/orgs/852/classrooms/456/teams/123/students/977"
    },
    {
      "rel": ["home"],
      "href": "/api"
    },
    {
      "rel": ["organization"],
      "href": "/api/orgs/123123"
    },
    {
      "rel": ["logout"],
      "href": "/api/logout"
    }
  ]
}

Get Student - Teacher

Teacher view of a Get Student request.

GET api/orgs/{orgId}/classrooms/{classId}/teams/{teamId}/students/{number}

Status:  200 OK

{
  "class": [ "student" ],
  "properties": {
      "number": 977,
      "name": "Julio Lourenço"
  },
  "entities": {
      "class": [ "team" ],
      "rel": [ "item" ],
      "properties": {
        "id": 123,
        "name": "team1",
        "state": "active"
      },
      "links": [
        {
          "rel": ["self"],
          "href": "/api/orgs/852/classrooms/456/teams/123"
        }
      ]
    },
    "actions": [
      {
        "name": "update-student",
        "title": "Update Student",
        "method": "PUT",
        "href": "/api/orgs/{orgId}/classrooms/{classId}/teams/123/students/977",
        "type": "application/json",
        "field": [
          {"name": "name", "type": "string"}
        ]
      },
      {
        "name": "add-student",
        "title": "Add Student",
        "method": "POST",
        "href": "/api/orgs/852/classrooms/123/teams/123/students",
        "type": "application/json",
        "field": [
          {"name": "number", "type": "number"}
        ]
      },
      {
        "name": "remove-student",
        "title": "Remove Student",
        "method": "DELETE",
        "href": "/api/orgs/852/classrooms/123/teams/123/students/977",
        "type": "application/json"
      }
    ],
  "links": [
    {
      "rel": ["self"],
      "href": "/api/orgs/852/classrooms/456/teams/123/students/977"
    },
    {
      "rel": ["home"],
      "href": "/api"
    },
    {
      "rel": ["organization"],
      "href": "/api/orgs/123123"
    },
    {
      "rel": ["logout"],
      "href": "/api/logout"
    }
  ]
}

Error Responses

Bad Request

Used in requests that return both collection and individual items.

Status: 400 Bad Request

{
  "type": "https://github.com/i-on-project/teams/blob/main/docs/api/problems/bad_request.md",
  "title": "The request parameters are invalid.",
  "status": 400,
  "detail": "Some parameters are missing or are of an invalid type."
}

Unauthorized

Used in requests that return both collection and individual items.

Status: 401 Unauthorized

{
  "type": "https://github.com/i-on-project/teams/blob/main/docs/api/problems/unauthorized.md",
  "title": "The request parameters are invalid.",
  "status": 401,
  "detail": "Some parameters are missing or are of an invalid type."
}

Not Found

Used only in requests that return individual items.

Status: 404 Not Found

{
  "type": "https://github.com/i-on-project/teams/blob/main/docs/api/problems/not_found.md",
  "title": "The request parameters are invalid.",
  "status": 404,
  "detail": "Some parameters are missing or are of an invalid type."
}

Conflict

Used in requests that return both collection and individual items.

Status: 409 Conflict

{
  "type": "https://github.com/i-on-project/teams/blob/main/docs/api/problems/conflict.md",
  "title": "There is a conflict with the request.",
  "status": 409,
  "detail": "There is a conflict with the request because the resource already exists."
}