Skip to content

home.md

Latest commit

 

History

History
283 lines (236 loc) · 5.59 KB

home.md

File metadata and controls

283 lines (236 loc) · 5.59 KB

Home

Home is Not yet completed

Properties

Domain specific

  • Organizations - List of Organizations.
    • id - Unique and stable global identifier
      • mandatory
      • non editable
      • type: number
      • example: 1
    • name - Unique and short name that defines the resource
      • mandatory
      • non editable
      • type: string
      • example: Some Organization
    • description - Description that characterizes the resource
      • non mandatory
      • non editable
      • type: string
      • example: This is some organization
    • pageIndex - Index of the current collection page
      • non mandatory
      • editable
      • type: number
      • example: 0
    • pageSize - Describes the number of elements in the current collection page
      • non mandatory
      • editable
      • type: number
      • example: 0
  • Classrooms - List of Classrooms.
    • (...)
  • Teams - List of Teams.
    • (...)
  • Deliveries - Upcoming Deliveries.
    • (...)

Media-type Siren

  • class
  • properties
  • entities
  • links
  • actions

Standard

  • item
  • rel

Link Relations

Domain Specific

Standard - IANA

Actions

Success Responses

Home Student

Request for home page of the Student, that shows all the classrooms that the student belongs.

GET /api
Status:  200 OK

{
  "class": [ "classrooms", "collection" ],
  "properties": {
    "pageIndex": 0,
    "pageSize": 1
  },
  "entities": [
    {
      "class": [ "classrooms" ],
      "rel": [ "item" ],
      "properties": {
        "id": 123123,
        "name": "LI61D",
        "state": "active",
        "schoolYear": "2021/22"
      },
      "links": [
        {
          "rel": ["self"],
          "href": "/api/orgs/852/classrooms/123123"
        },
        {
          "rel": ["teams"],
          "href": "/api/orgs/852/classrooms/123123/teams"
        },
        {
          "rel": ["assignments"],
          "href": "/api/orgs/852/classrooms/123123/assignments"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": ["self"],
      "href": "/api/orgs/852/classrooms?page=0&limit=10"
    },
    {
      "rel": ["next"],
      "href": "/api/orgs/852/classrooms?page=1&limit=10"
    },
    {
      "rel": ["prev"],
      "href": "/api/orgs/852/classrooms?page=1&limit=10"
    },
    {
      "rel": ["logout"],
      "href": "/api/logout"
    },
    {
      "rel": ["organizations"],
      "href": "/api/orgs"
    }
  ]
}

Home Teacher

Request for home page of the Teacher, that shows all the organizations that the teacher belongs.

GET /api
Status:  200 OK

{
  "class": [ "organizations", "collection" ],
  "properties": {
    "pageIndex": 0,
    "pageSize": 1
  },
  "entities": [
    {
      "class": [ "organization" ],
      "rel": [ "item" ],
      "properties": {
        "id": 852,
        "name": "i-on-project",
        "description": "GitHub organization for the i-on projects"
      },
      "links": [
        {
          "rel": ["self"],
          "href": "/api/orgs/852"
        },
        {
          "rel": ["classrooms"],
          "href": "/api/orgs/852/classrooms"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": ["self"],
      "href": "/api/orgs?page=0&limit=10"
    },
    {
      "rel": ["next"],
      "href": "/api/orgs?page=1&limit=10"
    },
    {
      "rel": ["prev"],
      "href": "/api/orgs?page=1&limit=10"
    },
    {
      "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."
}