Search parameter in Rest API

Introduction

A search parameter helps you find specific information from a large set of data by telling the system what to look for.

When you want to find all users with a specific name in a database.

When you need to get products within a certain price range from an online store.

When filtering blog posts by a particular tag or category.

When searching for events happening on a certain date.

When retrieving records that match a specific status or condition.

Syntax

Rest API

GET /resource?searchKey=searchValue

The search parameter is added after the question mark (?) in the URL.

Multiple parameters can be added using the ampersand (&) symbol.

Examples

Finds users whose name is 'alice'.

Rest API

GET /users?name=alice

Finds products in the 'books' category priced at 20 units.

Rest API

GET /products?category=books&price=20

Finds events happening on June 1, 2024.

Rest API

GET /events?date=2024-06-01

Sample Program

This program sends a request to a web API to find users named 'bob'. It then prints how many users were found and their details.

Rest API

import requests

# URL with search parameter to find users named 'bob'
url = 'https://api.example.com/users?name=bob'

response = requests.get(url)

if response.status_code == 200:
    users = response.json()
    print(f"Found {len(users)} users named 'bob':")
    for user in users:
        print(f"- {user['name']} (ID: {user['id']})")
else:
    print('Failed to get users')

Important Notes

Search parameters are case sensitive depending on the API.

Always encode special characters in search values to avoid errors.

Check API documentation for supported search keys and formats.

Summary

Search parameters help filter data by specifying what you want.

They are added to the URL after a question mark (?).

Multiple parameters can be combined using &.

Practice

1.

What is the main purpose of a search parameter in a REST API URL?

easy

A. To change the API server address

B. To filter the data returned by the API

C. To add security to the API

D. To format the API response as XML

Solution

1. Step 1: Understand what search parameters do

   Search parameters are added to the URL to specify what data you want from the API.

2. Step 2: Identify the purpose of filtering

   Filtering means selecting only the data that matches your criteria, which is what search parameters do.

3. Final Answer:

   To filter the data returned by the API -> Option B

4. Quick Check:

   Search parameter = filter data [OK]

Hint: Search parameters filter data in API URLs [OK]

Common Mistakes:

• Thinking search parameters change server address
• Confusing search parameters with security tokens
• Assuming search parameters format response

2.

Which of the following is the correct way to add a search parameter named name with value alice to a REST API URL?

https://api.example.com/users

easy

A. https://api.example.com/users#name=alice

B. https://api.example.com/users/name=alice

C. https://api.example.com/users?name=alice

D. https://api.example.com/users&name=alice

Solution

1. Step 1: Recall the syntax for search parameters

   Search parameters start with a question mark (?) after the base URL.

2. Step 2: Check the correct separator and format

   The parameter is added as ?name=alice. Using & or # or slashes is incorrect here.

3. Final Answer:

   https://api.example.com/users?name=alice -> Option C

4. Quick Check:

   Use ? before first parameter [OK]

Hint: First parameter starts with ? in URL [OK]

Common Mistakes:

• Using & instead of ? for first parameter
• Using # which is for anchors, not parameters
• Adding parameters as path segments

3.

What will be the full URL to search for users with age 30 and city as NY?

Base URL: https://api.example.com/users

medium

A. https://api.example.com/users?age=30&city=NY

B. https://api.example.com/users?age=30?city=NY

C. https://api.example.com/users&age=30&city=NY

D. https://api.example.com/users#age=30&city=NY

Solution

1. Step 1: Add first parameter with ?

   The first search parameter starts with a question mark: ?age=30.

2. Step 2: Add second parameter with &

   Additional parameters use & to separate: &city=NY.

3. Final Answer:

   https://api.example.com/users?age=30&city=NY -> Option A

4. Quick Check:

   First ? then & for multiple parameters [OK]

Hint: Use ? for first, & for others in URL [OK]

Common Mistakes:

• Using ? for every parameter
• Using & before first parameter
• Using # which is for anchors

4.

Identify the error in this URL with search parameters:

https://api.example.com/products?category=books&price=20?sort=asc

medium

A. Using two question marks (?) for parameters

B. Missing & between parameters

C. Using = instead of : in parameters

D. Parameters should be in the URL path, not query

Solution

1. Step 1: Check parameter separators

   Only the first parameter uses ?, others must use &.

2. Step 2: Identify the error in the URL

   The URL incorrectly uses a second ? before sort=asc instead of &.

3. Final Answer:

   Using two question marks (?) for parameters -> Option A

4. Quick Check:

   Only one ? allowed, others use & [OK]

Hint: Only one ? in URL, then & for others [OK]

Common Mistakes:

• Using multiple ? instead of &
• Confusing = with : in parameters
• Thinking parameters belong in URL path

5.

You want to search a REST API for books with author as John and year greater than 2010. Which URL correctly uses search parameters to do this?

hard

A. https://api.example.com/books?author=John&year>2010

B. https://api.example.com/books?author=John&year=2010>

C. https://api.example.com/books?author=John&year=gt2010

D. https://api.example.com/books?author=John&year_gt=2010

Solution

1. Step 1: Understand how to express 'greater than' in search parameters

   REST APIs often use suffixes like _gt for 'greater than' in parameters.

2. Step 2: Check each option for correct syntax

   https://api.example.com/books?author=John&year_gt=2010 uses year_gt=2010, which is a common and correct way to express this filter.

3. Final Answer:

   https://api.example.com/books?author=John&year_gt=2010 -> Option D

4. Quick Check:

   Use _gt suffix for greater than filters [OK]

Hint: Use _gt suffix for 'greater than' in parameters [OK]

Common Mistakes:

• Using > directly in URL parameter
• Placing operators after values
• Confusing parameter syntax for filters