Why Partial success handling in Rest API? - Purpose & Use Cases

The Big Idea

What if your app could tell you exactly which parts worked and which didn't, saving you hours of guesswork?

The Scenario

Imagine you send a request to update 100 user records via an API. Some updates succeed, but a few fail due to validation errors or network issues. Without partial success handling, you get a simple failure response and no clear info on which updates worked.

The Problem

Manually checking each record's update status is slow and confusing. You might retry everything or lose track of what succeeded. This wastes time and can cause data inconsistency or duplicated work.

The Solution

Partial success handling lets the API respond with detailed info: which parts succeeded, which failed, and why. This clear feedback helps you handle errors smartly, retry only failed parts, and keep your data accurate.

Before vs After

✗ Before

POST /updateUsers
Response: 500 Internal Server Error

✓ After

POST /updateUsers
Response: 207 Multi-Status
{
  "success": [1,2,5],
  "failed": {"3": "Invalid email", "4": "Timeout"}
}

What It Enables

It enables robust, efficient APIs that communicate exactly what worked and what didn't, making error handling smarter and user experiences smoother.

Real Life Example

When uploading multiple photos to a social app, partial success handling lets you know which photos uploaded successfully and which failed, so you can retry only the failed ones without losing progress.

Key Takeaways

Manual all-or-nothing responses hide useful info and cause frustration.

Partial success handling gives clear, detailed feedback on each part of a request.

This leads to smarter error handling and better user experiences.

Practice

1. What does HTTP 207 Multi-Status indicate in REST API partial success handling?

easy

A. Some parts of the request succeeded while others failed

B. The entire request failed due to server error

C. The request was redirected to another URL

D. The request was successful with no errors

Solution

1. Step 1: Understand HTTP 207 Multi-Status meaning

   HTTP 207 is used to report multiple status codes for different parts of a single request.

2. Step 2: Relate to partial success handling

   This status code indicates that some parts succeeded and others failed, providing detailed results.

3. Final Answer:

   Some parts of the request succeeded while others failed -> Option A

4. Quick Check:

   HTTP 207 = Partial success [OK]

Hint: 207 means mixed results, not full success or failure [OK]

Common Mistakes:

• Confusing 207 with 200 OK
• Thinking 207 means full failure
• Assuming 207 is a redirect status

2. Which of the following is the correct way to represent partial success in a REST API response?

easy

A. HTTP 404 with error message

B. HTTP 200 with empty body

C. HTTP 207 with JSON detailing success and failure

D. HTTP 500 with stack trace

Solution

1. Step 1: Identify correct HTTP status for partial success

   HTTP 207 Multi-Status is designed to show multiple results in one response.

2. Step 2: Confirm response format

   Using JSON to detail which parts succeeded or failed is the standard approach.

3. Final Answer:

   HTTP 207 with JSON detailing success and failure -> Option C

4. Quick Check:

   207 + JSON = Partial success response [OK]

Hint: Use 207 with JSON for partial success, not 200 or errors [OK]

Common Mistakes:

• Using 200 OK without details
• Returning 404 for partial success
• Sending server error 500 instead of partial status

3. Given this partial success JSON response, what is the status of item with ID 3?

{
  "responses": [
    {"id": 1, "status": "success"},
    {"id": 2, "status": "failure", "error": "Invalid data"},
    {"id": 3, "status": "success"}
  ]
}

medium

A. Failure due to invalid data

B. Success

C. Unknown status

D. Pending

Solution

1. Step 1: Locate item with ID 3 in JSON

   Item with ID 3 has "status": "success" in the responses array.

2. Step 2: Interpret the status value

   The status "success" means the operation for item 3 succeeded.

3. Final Answer:

   Success -> Option B

4. Quick Check:

   ID 3 status = success [OK]

Hint: Check the status field for the item ID in JSON [OK]

Common Mistakes:

• Confusing failure of other items with this one
• Assuming missing error means failure
• Ignoring the status field

4. You receive this HTTP response code and body from a batch update API:

HTTP/1.1 207 Multi-Status
{
  "results": [
    {"item": "A", "status": "success"},
    {"item": "B", "status": "fail", "error": "Timeout"}
  ]
}

What is the main issue in this response?

medium

A. Incorrect HTTP status code for partial success

B. JSON format is invalid

C. Missing Content-Type header

D. The status value "fail" should be "failure" or "error"

Solution

1. Step 1: Check HTTP status code usage

   HTTP 207 Multi-Status is correct for partial success.

2. Step 2: Verify status field values

   Common practice uses "success" and "failure" or "error"; "fail" is inconsistent and may cause confusion.

3. Final Answer:

   The status value "fail" should be "failure" or "error" -> Option D

4. Quick Check:

   Status values must be consistent and clear [OK]

Hint: Use standard status words like 'success' and 'failure' [OK]

Common Mistakes:

• Thinking 207 is wrong here
• Ignoring inconsistent status wording
• Assuming JSON is invalid without checking

5. You design a REST API endpoint that processes a list of user updates. Some updates succeed, others fail due to validation errors. How should you structure the response to clearly communicate partial success?

hard

A. Return HTTP 207 with a JSON array showing each user's update status and error if any

B. Return HTTP 400 with a generic error message for all failures

C. Return HTTP 200 with a simple success message ignoring failures

D. Return HTTP 500 with server error details

Solution

1. Step 1: Identify the need for partial success reporting

   Since some updates succeed and others fail, the response must show both results clearly.

2. Step 2: Choose appropriate HTTP status and response format

   HTTP 207 Multi-Status with detailed JSON per user update is the best practice to communicate partial success.

3. Final Answer:

   Return HTTP 207 with a JSON array showing each user's update status and error if any -> Option A

4. Quick Check:

   207 + detailed JSON = clear partial success [OK]

Hint: Use 207 and detailed JSON for mixed success/failure results [OK]

Common Mistakes:

• Ignoring failed updates in response
• Using 200 OK without details
• Returning generic errors instead of per-item status