GET for reading resources in Rest API - Step-by-Step Execution

Concept Flow - GET for reading resources

Client sends GET request

↓

Server receives request

↓

Server looks up resource

↓

Resource found?

No→Send 404 Not Found

Yes↓

Send resource data in response

↓

Client receives data

The client sends a GET request to the server, which looks up the requested resource and returns it if found, or a 404 error if not.

Execution Sample

Rest API

GET /books/123 HTTP/1.1
Host: example.com

Client requests the book with ID 123 from the server.

Execution Table

Step	Action	Evaluation	Result
1	Client sends GET /books/123	Request sent to server	Request received by server
2	Server checks if book 123 exists	Book 123 found in database	Proceed to send data
3	Server sends book data in response	Response includes book details	Client receives book data
4	Client processes response	Status 200 OK	Book details displayed to user

💡 Resource found and data sent successfully, ending GET request cycle.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
request	None	GET /books/123	GET /books/123	Completed
resource_found	False	True	True	True
response_status	None	None	200 OK	200 OK
response_data	None	None	{book details}	{book details}

Key Moments - 2 Insights

Why does the server send a 404 error sometimes?

If the resource is not found (see Step 2 in execution_table), the server sends a 404 Not Found response instead of data.

Does GET change any data on the server?

No, GET only reads data and returns it. It does not modify anything on the server (confirmed by no update steps in execution_table).

Visual Quiz - 3 Questions

Look at the execution_table, what is the response status after Step 3?

A 404 Not Found

B 200 OK

C 500 Internal Server Error

D 301 Moved Permanently

💡 Hint

Check the 'response_status' variable in variable_tracker after Step 3.

At which step does the server confirm the resource exists?

A Step 2

B Step 3

C Step 1

D Step 4

💡 Hint

Look at the 'Action' and 'Evaluation' columns in execution_table for resource lookup.

If the resource was not found, how would the execution_table change?

A Step 4 would show status 500

B Step 1 would be skipped

C Step 2 would show 'Book 123 not found' and Step 3 would send 404 response

D No change, same steps occur

💡 Hint

Consider what happens when 'resource_found' is False in variable_tracker.

Concept Snapshot

GET request reads data from server
Client sends GET with resource URL
Server checks resource existence
If found, sends data with 200 OK
If not found, sends 404 Not Found
GET does not modify server data

Full Transcript

This visual execution shows how a GET request works to read resources from a server. First, the client sends a GET request for a specific resource, like a book with ID 123. The server receives this request and looks up the resource in its database. If the resource is found, the server sends back the data with a 200 OK status. The client then receives and displays this data. If the resource is not found, the server would send a 404 Not Found error instead. Throughout this process, the GET request only reads data and does not change anything on the server.

Practice

1. What is the main purpose of a GET request in REST API?

easy

A. To read or fetch data from the server

B. To create new data on the server

C. To update existing data on the server

D. To delete data from the server

Solution

1. Step 1: Understand the HTTP methods

   GET is one of the HTTP methods used in REST APIs. It is specifically designed to retrieve data without changing it.

2. Step 2: Identify the purpose of GET

   GET requests fetch or read data from the server without modifying it, unlike POST, PUT, or DELETE.

3. Final Answer:

   To read or fetch data from the server -> Option A

4. Quick Check:

   GET = Read data [OK]

Hint: GET always fetches data without changing it [OK]

Common Mistakes:

• Confusing GET with POST which creates data
• Thinking GET deletes data
• Assuming GET updates data

2. Which of the following is the correct syntax for a GET request URL to fetch a user with ID 5?

easy

A. POST /users/5

B. POST /users?id=5

C. GET /users/5

D. DELETE /users/5

Solution

1. Step 1: Identify the HTTP method for reading

   GET is the correct method to read or fetch data, so the method must be GET.

2. Step 2: Check the URL path for resource

   /users/5 is the typical RESTful path to get a user with ID 5. Other options use wrong HTTP methods.

3. Final Answer:

   GET /users/5 -> Option C

4. Quick Check:

   GET + resource path = correct syntax [OK]

Hint: GET method + resource path fetches data [OK]

Common Mistakes:

• Using POST or DELETE instead of GET
• Using query parameters incorrectly
• Mixing HTTP methods and URLs

3. Given the following GET request URL: /products?category=books&limit=3, what does the server most likely return?

medium

A. All products without filtering

B. Products with category 'limit' and quantity 3

C. An error because of invalid query parameters

D. First 3 products in the books category

Solution

1. Step 1: Analyze the query parameters

   The URL has two query parameters: category=books and limit=3, which filter products by category and limit the number returned.

2. Step 2: Understand typical API behavior

   APIs commonly use 'category' to filter items and 'limit' to restrict the number of results returned.

3. Final Answer:

   First 3 products in the books category -> Option D

4. Quick Check:

   Query filters + limit = filtered limited results [OK]

Hint: Query params filter and limit results [OK]

Common Mistakes:

• Ignoring query parameters and returning all data
• Misreading 'limit' as a category
• Assuming query causes error

4. Identify the error in this GET request example: GET /users/ with body {"id": 10}

medium

A. The URL is missing the user ID

B. GET requests should not have a body

C. The HTTP method should be POST

D. The JSON body is missing a field

Solution

1. Step 1: Understand GET request rules

   GET requests do not send a body; they pass parameters via URL path or query string.

2. Step 2: Check the given request

   The request has a JSON body, which is invalid for GET and ignored by most servers.

3. Final Answer:

   GET requests should not have a body -> Option B

4. Quick Check:

   GET = no body allowed [OK]

Hint: GET requests never include a body [OK]

Common Mistakes:

• Adding body data to GET requests
• Confusing GET with POST or PUT
• Assuming URL must always include ID

5. You want to fetch a list of active users created after 2023-01-01 using a GET request. Which URL is the best choice?

hard

A. GET /users?status=active&created_after=2023-01-01

B. GET /users/active/2023-01-01

C. POST /users with body {"status":"active","created_after":"2023-01-01"}

D. GET /users {"status":"active","created_after":"2023-01-01"}

Solution

1. Step 1: Choose correct HTTP method and URL format

   GET is used to read data. Query parameters are the standard way to filter resources in GET requests.

2. Step 2: Analyze options for filtering

   GET /users?status=active&created_after=2023-01-01 uses query parameters to filter by status and creation date, which is the correct RESTful approach.

3. Final Answer:

   GET /users?status=active&created_after=2023-01-01 -> Option A

4. Quick Check:

   GET + query filters = correct usage [OK]

Hint: Use query parameters to filter GET requests [OK]

Common Mistakes:

• Using POST instead of GET for reading
• Putting filters in URL path incorrectly
• Sending body with GET request