Skip to content

PUT.md

Latest commit

 

History

History
123 lines (105 loc) · 3.45 KB

PUT.md

File metadata and controls

123 lines (105 loc) · 3.45 KB

To make a PUT request to update a student using your API, follow the steps below. The PUT endpoint in your controller is designed to replace all fields of an existing student with the data provided in the request body.

PUT Request Details

  • Endpoint: PUT /api/students/{id}
  • Purpose: Update all fields of a student with the given id.
  • Request Body: A Student object in XML or JSON format.
  • Headers:
    • Content-Type: application/json or application/xml (depending on your input format).
    • Accept: application/json or application/xml (depending on your desired response format).

Example Requests

1. Using curl (Command Line)

JSON Example:

curl -X PUT "https://restapiapp.onrender.com/api/students/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "id": 1,
  "name": "Arvind Updated",
  "location": "Mumbai",
  "phone": "9876543210",
  "course": ["MCA"]
}'

XML Example:

curl -X PUT "https://restapiapp.onrender.com/api/students/1" \
-H "Content-Type: application/xml" \
-H "Accept: application/xml" \
-d '<student>
        <id>1</id>
        <name>Arvind Updated</name>
        <location>Mumbai</location>
        <phone>9876543210</phone>
        <courses>
            <course>MBA</course>
            <course>MCA</course>
        </courses>
    </student>'

2. Using Postman

  1. Set the HTTP method to PUT.
  2. Enter the URL: https://restapiapp.onrender.com/api/students/1 (replace 1 with the student’s ID).
  3. Add headers:
    • Content-Type: application/json or application/xml.
    • Accept: application/json or application/xml.
  4. In the request body, provide the updated student data in raw format (JSON or XML).

JSON Body:

{
  "id": 1,
  "name": "Arvind Updated",
  "location": "Mumbai",
  "phone": "9876543210",
  "course": ["MBA", "MCA"]
}

XML Body:

<student>
    <id>1</id>
    <name>Arvind Updated</name>
    <location>Mumbai</location>
    <phone>9876543210</phone>
    <courses>
        <course>MBA</course>
    </courses>
</student>

3. Using JavaScript (fetch API)

fetch('https://restapiapp.onrender.com/api/students/1', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  body: JSON.stringify({
    id: 1,
    name: "Arvind Updated",
    location: "Mumbai",
    phone: "9876543210",
    course: ["MBA", "MCA"]
  })
})
.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 match the id in the request body.
  2. Field Requirements: All fields (name, location, phone, course) must be provided in the request body (PUT replaces the entire resource).
  3. Response:
    • 200 OK: Success + message: "Student updated successfully".
    • 404 Not Found: If the student with the given id does not exist.
    • 500 Internal Server Error: If there’s a server-side issue.

Troubleshooting

  • XML Structure: Ensure the XML request body uses <courses> as the wrapper and <course> for individual items.
  • Data Types: The id is an integer (int), not a string.
  • Validation: If the course list is empty or fields like name are missing, the API may throw errors (depending on your validation rules).