Bird
Raised Fist0
Rest APIprogramming~5 mins

Error codes for machine consumption in Rest API - Time & Space Complexity

Choose your learning style10 modes available
LearnWhyDeepVisualTryChallengeProjectRecallTime

Start learning this pattern below

Jump into concepts and practice - no test required

or
Recommended
Test this pattern10 questions across easy, medium, and hard to know if this pattern is strong
Time Complexity: Error codes for machine consumption
O(n)
Understanding Time Complexity

When APIs return error codes for machines to read, it is important to know how the processing time changes as more errors or requests happen.

We want to understand how the time to handle error codes grows when the number of requests increases.

Scenario Under Consideration

Analyze the time complexity of the following code snippet.


// Example: Handling error codes in API responses
function handleErrors(errors) {
  for (let i = 0; i < errors.length; i++) {
    logError(errors[i].code);
  }
}

function logError(code) {
  // Simulate logging error code
  console.log(`Error code: ${code}`);
}

This code loops through a list of error codes and logs each one for machine consumption.

Identify Repeating Operations

Identify the loops, recursion, array traversals that repeat.

  • Primary operation: Looping through the error codes array.
  • How many times: Once for each error in the list.
How Execution Grows With Input

As the number of error codes increases, the time to process them grows in a straight line.

Input Size (n)Approx. Operations
1010 logging calls
100100 logging calls
10001000 logging calls

Pattern observation: Doubling the number of errors doubles the work.

Final Time Complexity

Time Complexity: O(n)

This means the time to handle error codes grows directly with the number of errors.

Common Mistake

[X] Wrong: "Logging error codes takes the same time no matter how many errors there are."

[OK] Correct: Each error code requires a separate action, so more errors mean more work.

Interview Connect

Understanding how error handling scales helps you design APIs that respond efficiently as usage grows.

Self-Check

"What if the error codes were grouped and logged once per group instead of individually? How would the time complexity change?"

Practice

(1/5)
1.

What is the main purpose of using error codes in a REST API?

easy
A. To tell machines what happened during a request
B. To make the API run faster
C. To change the API's URL
D. To store user data securely

Solution

  1. Step 1: Understand the role of error codes

    Error codes are used to communicate the result of a request to the client or machine.

  2. Step 2: Identify the correct purpose

    The main purpose is to inform machines about success or failure of requests, enabling automated handling.

  3. Final Answer:

    To tell machines what happened during a request -> Option A

  4. Quick Check:

    Error codes = communicate request status [OK]
Hint: Error codes explain request results to machines [OK]
Common Mistakes:
  • Thinking error codes speed up the API
  • Confusing error codes with data storage
  • Believing error codes change URLs
2.

Which HTTP status code correctly indicates a successful request in a REST API?

Choose the correct code:

easy
A. 404
B. 500
C. 200
D. 301

Solution

  1. Step 1: Recall common HTTP status codes

    200 means OK (success), 404 means Not Found, 500 means Server Error, 301 means Redirect.

  2. Step 2: Identify success code

    200 is the standard code for a successful HTTP request.

  3. Final Answer:

    200 -> Option C

  4. Quick Check:

    Success code = 200 [OK]
Hint: 200 means success in HTTP status codes [OK]
Common Mistakes:
  • Choosing 404 thinking it means success
  • Confusing 500 with success
  • Selecting 301 which is a redirect
3.

Given this JSON error response from a REST API:

{
  "status": 404,
  "error": "Resource not found"
}

What does the 404 status code mean?

medium
A. The request was successful
B. The requested resource does not exist
C. The server encountered an error
D. The client is not authorized

Solution

  1. Step 1: Understand HTTP 404 status code meaning

    404 means the requested resource was not found on the server.

  2. Step 2: Match the error message with the code

    The message "Resource not found" confirms the meaning of 404.

  3. Final Answer:

    The requested resource does not exist -> Option B

  4. Quick Check:

    404 = resource missing [OK]
Hint: 404 means resource missing or not found [OK]
Common Mistakes:
  • Thinking 404 means success
  • Confusing 404 with server error
  • Assuming 404 means unauthorized
4.

Look at this REST API error response snippet:

{
  "status": 200,
  "error": "Invalid input data"
}

What is wrong with this error code usage?

medium
A. Status 200 should not be used with an error message
B. The error message is missing a code
C. Status 200 means server error
D. The JSON format is incorrect

Solution

  1. Step 1: Analyze the status code and message

    Status 200 means success, but the message says "Invalid input data" which is an error.

  2. Step 2: Identify the mismatch

    Using 200 with an error message is incorrect; error codes like 400 should be used for invalid input.

  3. Final Answer:

    Status 200 should not be used with an error message -> Option A

  4. Quick Check:

    Status 200 = success, not error [OK]
Hint: Match error messages with proper error status codes [OK]
Common Mistakes:
  • Ignoring mismatch between status and message
  • Thinking 200 can mean error
  • Assuming JSON format is wrong
5.

You want to design a REST API that returns error codes machines can easily understand and act on. Which approach is best?

Choose the best practice:

hard
A. Return random status codes to confuse attackers
B. Return only HTTP status codes without any message body
C. Return success status codes even when errors happen, but include error details in HTML
D. Return HTTP status codes with clear JSON error messages explaining the problem

Solution

  1. Step 1: Understand best practices for machine-readable errors

    Machines need both status codes and clear JSON messages to understand errors and automate responses.

  2. Step 2: Evaluate options

    Return HTTP status codes with clear JSON error messages explaining the problem provides both HTTP status codes and JSON messages, which is the recommended approach.

  3. Final Answer:

    Return HTTP status codes with clear JSON error messages explaining the problem -> Option D

  4. Quick Check:

    Status + JSON error message = best practice [OK]
Hint: Use status codes plus JSON messages for clear machine errors [OK]
Common Mistakes:
  • Sending no message body with status codes
  • Using success codes for errors
  • Returning HTML instead of JSON for errors