Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GET] A Single Teacher Review #172

Closed
Tracked by #23
arafaysaleem opened this issue Nov 5, 2021 · 0 comments · Fixed by #176
Closed
Tracked by #23

[GET] A Single Teacher Review #172

arafaysaleem opened this issue Nov 5, 2021 · 0 comments · Fixed by #176
Assignees
Labels
Status: Completed Type: Feature user story A brief explanation of a functionality or an interaction with the system, from a user's perspective

Comments

@arafaysaleem
Copy link
Collaborator

arafaysaleem commented Nov 5, 2021

Summary

As a student, I should be able to get details of a teacher review, so that I can understand what information it represents.

Acceptance Criteria

GIVEN a student is requesting details of a teacher review in the app
WHEN the app hits the /teacher-reviews/:id endpoint with a valid GET request, containing the path parameter:

  • :id, the unique id of the entity for which the details are needed.

THEN the app should receive a status 200
AND in the response, the following information should be returned:

  • headers
  • teacher review details

Sample Request/Sample Response

headers: {
    error: 0,
    message: "..."
}
body: {
        review_id: 1,
  	learning: 3,
  	grading: 3,
  	attendance: 3,
  	difficulty: 5,
  	overall_rating: 3.5,
  	comment: "Won't recommend taking this course from this teacher",
  	reviewed_at: "2021-11-04 02:18:00",
  	subject_code: "MKT151",
  	teacher_id: 1,
  	reviewed_by_erp: 17855
}

Resources

  • Development URL: {Here goes a URL to the feature on development API}
  • Production URL: {Here goes a URL to the feature on production API}

Dev Notes

This endpoint is accessible by and serves the admin in the same way.

Testing Notes

Scenario 1: GET request is successful

GIVEN a student is requesting details of a teacher review in the app
WHEN the app hits the /teacher-reviews/:id endpoint with a valid GET request, containing the path parameter:

  • :id

THEN the app should receive a status 200
AND the {id} in the body should be same as the :id in the path parameter

Scenario 2: GET request is unsuccessful

GIVEN a student is requesting details of a teacher review in the app
WHEN the app hits the /teacher-reviews/:id endpoint with a valid GET request, containing the path parameter:

  • :id, a non-existent id

THEN the app should receive a status 404
AND the response headers' id parameter should contain "NotFoundException"

Scenario 3: GET request is unauthorized

GIVEN a student is requesting details of a teacher review in the app
WHEN the app hits the /teacher-reviews/:id endpoint with a valid GET request
AND the request contains no authorization token
THEN the app should receive a status 401
AND the response headers' id parameter should contain "TokenMissingException"

@arafaysaleem arafaysaleem added Priority: Medium Status: Pending Type: Feature user story A brief explanation of a functionality or an interaction with the system, from a user's perspective Priority: Low and removed Priority: Medium labels Nov 5, 2021
@arafaysaleem arafaysaleem self-assigned this Nov 5, 2021
@arafaysaleem arafaysaleem mentioned this issue Nov 5, 2021
8 tasks
@arafaysaleem arafaysaleem mentioned this issue Nov 25, 2021
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Completed Type: Feature user story A brief explanation of a functionality or an interaction with the system, from a user's perspective
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant