Skip to content

DELETE.md

Latest commit

 

History

History
105 lines (85 loc) · 2.76 KB

DELETE.md

File metadata and controls

105 lines (85 loc) · 2.76 KB

To make a DELETE request to remove a student using your API, follow the steps below. The DELETE endpoint in your controller is designed to delete a student with the specified id.

DELETE Request Details

  • Endpoint: DELETE /api/students/{id}
  • Purpose: Delete a student with the given id.
  • Headers:
    • Accept: application/json or application/xml (for the response format).
  • Response:
    • 200 OK: Success + message: "Student deleted successfully".
    • 404 Not Found: If the student with the given id does not exist.

Example Requests

1. Using curl (Command Line)

JSON Example:

curl -X DELETE "https://restapiapp.onrender.com/api/students/1" \
-H "Accept: application/json"

XML Example:

curl -X DELETE "https://restapiapp.onrender.com/api/students/1" \
-H "Accept: application/xml"

2. Using Postman

  1. Set the HTTP method to DELETE.
  2. Enter the URL: https://restapiapp.onrender.com/api/students/1 (replace 1 with the student’s ID).
  3. Add headers:
    • Accept: application/json or application/xml.
  4. Send the request.

3. Using JavaScript (fetch API)

fetch('https://restapiapp.onrender.com/api/students/1', {
  method: 'DELETE',
  headers: {
    'Accept': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

Key Notes

  1. ID Matching: The id in the URL path (/students/{id}) must correspond to an existing student.
  2. Response:
    • 200 OK: Success + message: "Student deleted successfully".
    • 404 Not Found: If the student with the given id does not exist.
  3. Data Types: The id is an integer (int), not a string.

Troubleshooting

  • Invalid ID: If the id is not found, the API will return a 404 Not Found response.
  • Non-Numeric ID: If the id is not a valid integer (e.g., abc), the API will return a 400 Bad Request error.

Example Scenarios

Scenario 1: Successful Deletion

  • Request: 
    curl -X DELETE "https://restapiapp.onrender.com/api/students/1" \
-H "Accept: application/json"
  • Response: 
    {
  "message": "Student deleted successfully"
}

Scenario 2: Student Not Found

  • Request: 
    curl -X DELETE "https://restapiapp.onrender.com/api/students/999" \
-H "Accept: application/json"
  • Response: 
    {
  "error": "Student not found"
}

Summary

  • DELETE is a straightforward operation to remove a resource.
  • Ensure the id in the URL matches an existing student.
  • Use the Accept header to specify the desired response format (JSON or XML).