Course Service

Course controller - port:8082 https://app.swaggerhub.com/apis/Afeka2020/ASIS/1.0.0

All operations that admin/lecturer/user can use. This service stores data about the courses in the system.

Student-Controller: Get all courses

GET /course

Get all courses from database

Query Parameters

Name	Type	Description
filterType	string
filterValue	string
direction	string
sort	string
page	integer
size	integer

200 Ok

{
  "code": 0,
  "department": {
    "code": 0,
    "name": "string"
  },
  "lecturersIdList": [
    {
      "email": "string",
      "id": "string",
      "username": "string"
    }
  ],
  "name": "string",
  "softwareIdList": [
    {
      "name": "string",
      "version": "string"
    }
  ],
  "studentsIdList": [
    {
      "email": "string",
      "id": "string",
      "username": "string"
    }
  ]
}

400 Bad request

401 Unauthorized

403 Forbidden

500 Internal server error

Student-Controller: Assign a student to a course

PATCH /course/{id}

Path Parameters

Name	Type	Description
code	integer

Query Parameters

Name	Type	Description
id	string

200 Ok

Ok

400 Bad request

401 Unauthorized

403 Forbidden

404 Not found

500 Server error

Student-Controller: Get student courses

GET /course/{id}

Path Parameters

Name	Type	Description
id	string

200 Ok

[
  {
    "code": 0,
    "lecturers": [
      {
        "email": "string",
        "id": "string",
        "username": "string"
      }
    ],
    "name": "string",
    "software": [
      {
        "id": "string",
        "name": "string",
        "version": "string"
      }
    ],
    "students": [
      {
        "email": "string",
        "id": "string",
        "username": "string"
      }
    ]
  }
]

400 Bad request

401 Unauthorized

403 Forbidden

404 Nor found

500 Internal server error

Admin-Controller: Get all Courses

GET /course/admin

Get all courses from the database

Query Parameters

Name	Type	Description
direction	string
filterType	string
filterValue	string
page	integer
size	integer
sortBy	string

200

[
  {
    "code": 0,
    "department": {
      "code": 0,
      "name": "string"
    },
    "lecturersIdList": [
      {
        "email": "string",
        "id": "string",
        "username": "string"
      }
    ],
    "name": "string",
    "softwareIdList": [
      {
        "name": "string",
        "version": "string"
      }
    ],
    "studentsIdList": [
      {
        "email": "string",
        "id": "string",
        "username": "string"
      }
    ]
  }
]

400 Bad request

401 Unauthorized

403 Forbidden

500 Internal server error

Admin-Controller: Create new Courses

POST /course/admin

Request Body

Name	Type	Description
courses	object

201 Resource created

[
  {
    "code": 0,
    "department": {
      "code": 0,
      "name": "string"
    },
    "lecturersIdList": [
      {
        "email": "string",
        "id": "string",
        "username": "string"
      }
    ],
    "name": "string",
    "softwareIdList": [
      {
        "name": "string",
        "version": "string"
      }
    ],
    "studentsIdList": [
      {
        "email": "string",
        "id": "string",
        "username": "string"
      }
    ]
  }
]

400 Bad request

401 Unauthorized

403 Forbidden

409 Conflict

500 Internal server error

Admin-Controller: Delete all courses

DELETE /course/admin

Delete courses from database

204 No content

Resource has deleted

401 Unauthorized

403 Forbidden

500 Internal server error

Admin-Controller: Edit course details

PUT /course/admin/{code}

Path Parameters

Name	Type	Description
code	integer

Request Body

Name	Type	Description
courseEdit	object

200 Ok

Resource has edited

400 Bad request

401 Unauthorized

403 Forbidden

404 Not found

500 Internal server error

Admin-Controller: Delete specific course

DELETE /course/admin/{code}

Remove course by course code

Path Parameters

Name	Type	Description
code	integer

204 No content

Resource has deleted

400 Bad request

401 Unauthorized

403 Forbidden

404 Not found

500 Internal server error

Admin-Controller: Remove Lecturer from course

DELETE /course/admin/{code}/{id}

Path Parameters

Name	Type	Description
code	integer
id	string

204 No content

Resource has deleted

400 Bad request

401 Unauthorized

403 Forbidden

404 Not found

500 Internal server error

Admin-Controller: Assign lecturer to course

PATCH /course/admin/{code}

Path Parameters

Name	Type	Description
code	integer

Query Parameters

Name	Type	Description
id	string

200 Ok

OK

400 Bad request

401 Unauthorized

403 Forbidden

404 Not found

500 Internal server error

Lecturer-Controller: Remove software to course

DELETE /course/lecturer/{code}

Path Parameters

Name	Type	Description
code	integer

Request Body

Name	Type	Description
idBoundary	object

204 No content

Resource has deleted

400 Bad request

401 Unauthorized

403 Forbidden

404 Not found

500 Internal server error

Lecturer-Controller: Add software to course

PATCH /course/lecturer/{code}

Path Parameters

Name	Type	Description
code	integer

Request Body

Name	Type	Description
idBoundary	object

200 Ok

{
  "code": 0,
  "lecturers": [
    {
      "email": "string",
      "id": "string",
      "username": "string"
    }
  ],
  "name": "string",
  "software": [
    {
      "id": "string",
      "name": "string",
      "version": "string"
    }
  ],
  "students": [
    {
      "email": "string",
      "id": "string",
      "username": "string"
    }
  ]
}

400 Bad request

401 Unauthorized

403 Forbidden

404 Resource not found

500 Internal server error

Lecturer-Controller: Find lecturer courses

GET /course/lecturer/{id}

Path Parameters

Name	Type	Description
id	string

200 Ok

[
  {
    "code": 0,
    "lecturers": [
      {
        "email": "string",
        "id": "string",
        "username": "string"
      }
    ],
    "name": "string",
    "software": [
      {
        "id": "string",
        "name": "string",
        "version": "string"
      }
    ],
    "students": [
      {
        "email": "string",
        "id": "string",
        "username": "string"
      }
    ]
  }
]

400 Bad request

401 Unauthorized

403 Forbidden

500 Internal server error