Partial success handling in Rest API - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does partial success handling mean in REST APIs?

It means the API can process some parts of a request successfully while others fail, and it informs the client about which parts succeeded and which failed.

intermediate

Which HTTP status code is commonly used to indicate partial success?

The status code 207 Multi-Status is often used to show partial success, especially in batch operations.

beginner

How can an API communicate details about which parts succeeded or failed?

By returning a detailed response body, often in JSON or XML, listing each item with its success or error status and messages.

beginner

Why is partial success handling useful in batch API requests?

It allows clients to know exactly which items were processed correctly and which need attention, avoiding full failure and retrying only failed parts.

intermediate

What is a common challenge when implementing partial success handling?

Ensuring the client can easily parse and understand the mixed success and failure results, and deciding how to handle retries or errors.

Which HTTP status code best represents partial success in a REST API?

A 207 Multi-Status

B 200 OK

C 404 Not Found

D 500 Internal Server Error

207 Multi-Status is designed to indicate that parts of the request succeeded while others failed.

In partial success handling, how does the API usually inform the client about individual item results?

A By sending an empty response

B By only sending a success message

C By closing the connection abruptly

D By sending a detailed response body with status for each item

A detailed response body helps the client understand which parts succeeded or failed.

Why might an API choose to implement partial success handling?

A To slow down the response time

B To reject all requests with any error

C To allow processing of valid parts without failing the whole request

D To avoid sending any error messages

Partial success lets the API process valid parts and inform about errors separately.

What is a typical format for partial success response details?

A JSON or XML listing each item's status

B Plain text with no structure

C Binary data

D HTML page

Structured formats like JSON or XML are easy for clients to parse and understand.

What should clients do when they receive a partial success response?

A Ignore the response

B Check which items failed and retry or handle errors accordingly

C Assume all items succeeded

D Send the same request again without changes

Clients should handle failed items based on the detailed response.

Explain what partial success handling is and why it is important in REST APIs.

Think about how APIs handle some parts working and others failing.

Describe how an API communicates partial success to a client, including status codes and response body.

Consider both HTTP status and message content.

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