get by filters

Retrieve Filtered Books

This endpoint retrieves a list of filtered books based on the provided pagination parameters.

Request

• Method: GET
• URL: {{baseUrl}}/books/filter
• Query Parameters:
  • page (number, required): The page number for pagination.
  • limit (number, required): The maximum number of books to be returned per page.

Response

The response for this request follows the JSON schema below:

{
  "data": {
    "books": {
      "docs": [
        {
          "_id": "string",
          "ISBN10": "string",
          "title": "string",
          "author": "string",
          "genre": "string",
          "price": 0,
          "publisher": "string",
          "isPrivatePublisher": true,
          "publishedDate": "string",
          "rating": 0,
          "createdAt": "string",
          "updatedAt": "string",
          "ISBN13": "string",
          "__v": 0
        }
      ],
      "totalDocs": 0,
      "offset": 0,
      "limit": 0,
      "totalPages": 0,
      "page": 0,
      "pagingCounter": 0,
      "hasPrevPage": true,
      "hasNextPage": true,
      "prevPage": null,
      "nextPage": null
    },
    "error": null
  }
}

GET /books/filter

get by filters

cURL

curl --request GET \
  --url http://localhost:8000/v1/books/filter

200

{
  "data": {
    "books": {
      "docs": [
        {
          "ISBN10": "2212122789",
          "ISBN13": "9782212122787",
          "__v": 0,
          "_id": "670e2ce78296c4aa4d1374ad",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T08:50:47.768Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T08:50:47.768Z"
        },
        {
          "ISBN10": "2212127869",
          "ISBN13": "9782212127867",
          "__v": 0,
          "_id": "670e1703d058e963ea3dd773",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:17:23.513Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:17:23.513Z"
        },
        {
          "ISBN10": "2212122469",
          "ISBN13": "9782212122466",
          "__v": 0,
          "_id": "670e16f0d058e963ea3dd770",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:17:04.842Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:17:04.842Z"
        },
        {
          "ISBN10": "2239122469",
          "ISBN13": "9782239122463",
          "__v": 0,
          "_id": "670e16cc9193a50b0ae84585",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:16:28.245Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:16:28.245Z"
        },
        {
          "ISBN10": "2237122469",
          "ISBN13": "9782237122465",
          "__v": 0,
          "_id": "670e168c882be0a10da8ed9a",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:15:24.295Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:15:24.295Z"
        },
        {
          "ISBN10": "2237122899",
          "ISBN13": "9782237122892",
          "__v": 0,
          "_id": "670e1678127bf79d1a36f1d5",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:15:04.594Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:15:04.594Z"
        },
        {
          "ISBN10": "2236722899",
          "ISBN13": "9782236722895",
          "__v": 0,
          "_id": "670e16460e5de5efb0969273",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:14:14.262Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:14:14.262Z"
        },
        {
          "ISBN10": "2236112899",
          "ISBN13": "9782236112894",
          "__v": 0,
          "_id": "670e161b7b1aa0919aad3fd7",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:13:31.436Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:13:31.436Z"
        },
        {
          "ISBN10": "2238212899",
          "ISBN13": "9782238212899",
          "__v": 0,
          "_id": "670e15cd755a3c061a312630",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:12:13.584Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:12:13.584Z"
        },
        {
          "ISBN10": "2238432899",
          "ISBN13": "9782238432891",
          "__v": 0,
          "_id": "670e155786ced1463b2b60c0",
          "author": "Marilynne Robinson",
          "createdAt": "2024-10-15T07:10:15.733Z",
          "genre": "670e14f586ced1463b2b60bc",
          "isPrivatePublisher": false,
          "price": 12200,
          "publishedDate": "2002-12-31T21:00:00.000Z",
          "publisher": "Abebe's publishing",
          "rating": 0,
          "title": "Gilead",
          "updatedAt": "2024-10-15T07:10:15.733Z"
        }
      ],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 10,
      "totalPages": 1
    }
  },
  "error": null
}

Query Parameters

page · string

Example:

"1"

limit · string

Example:

"10"

publisher · string

Example:

"abe"

author · string

Example:

"step"

publishDateFilter · string

Example:

"On"

priceFilter · string

Example:

"Greater"

price · string

Example:

"122"

Response

200

application/json

get by filters - success

data · object

Show child attributes

error · unknown