Finders

GET /api/finders

• Description: Retrieves a list of all finders.

• Parameters: None

• Example Request:

  GET /api/finders

• Response:

  • 200 OK: Returns an array of finder objects.

  • 4XX/5XX: Returns an error message if the request fails.

GET /api/finders/{id}

• Description: Retrieves details of a specific finder by ID.

• Parameters:

  • id (integer): ID of the finder.

• Example Request:

  GET /api/finders/1

• Response:

  • 200 OK: Returns the finder object.

  • 404 Not Found: If the finder with the specified ID does not exist.

  • 4XX/5XX: Returns an error message if the request fails.

POST /api/finders

• Description: Creates a new finder.

• Parameters: None (Data is sent in the request body)

• Request Body:

  {
    "title": "New Finder",
    "description": "Description of the new finder",
    "owners": [1],
    "maps": [2, 3],
    "advanced_refinements": [
      {
        "name": "Refinement Name",
        "values": [
          { "value": "filter.tags.equals.['football','soccer']" }
        ]
      }
    ],
    "authorized_urls": ["https://example.com"]
  }

• Example Request:

  POST /api/finders
  Content-Type: application/json
  
  {
    "title": "New Finder",
    "description": "Description of the new finder",
    "owners": [1],
    "maps": [2, 3],
    "advanced_refinements": [
      {
        "name": "Refinement Name",
        "values": [
          { "value": "filter.tags.equals.['football','soccer']" }
        ]
      }
    ],
    "authorized_urls": ["https://example.com"]
  }

• Response:

  • 201 Created: Returns the created finder object.

  • 4XX/5XX: Returns an error message if the request fails.

PUT /api/finders/{id}

• Description: Updates an existing finder by ID.

• Parameters:

  • id (integer): ID of the finder.

• Request Body:

  {
    "title": "Updated Finder",
    "description": "Updated description",
    "owners": [2],
    "maps": [3, 4],
    "advanced_refinements": [
      {
        "name": "Updated Refinement",
        "values": [
          { "value": "filter.categories.contains.['music']" }
        ]
      }
    ],
    "authorized_urls": ["https://newexample.com"]
  }

• Example Request:

  PUT /api/finders/1
  Content-Type: application/json
  
  {
    "title": "Updated Finder",
    "description": "Updated description",
    "owners": [2],
    "maps": [3, 4],
    "advanced_refinements": [
      {
        "name": "Updated Refinement",
        "values": [
          { "value": "filter.categories.contains.['music']" }
        ]
      }
    ],
    "authorized_urls": ["https://newexample.com"]
  }

• Response:

  • 200 OK: Returns the updated finder object.

  • 404 Not Found: If the finder with the specified ID does not exist.

  • 4XX/5XX: Returns an error message if the request fails.

DELETE /api/finders/{id}

• Description: Deletes a finder by ID.

• Parameters:

  • id (integer): ID of the finder.

• Example Request:

  DELETE /api/finders/1

• Response:

  • 200 OK: Confirmation of deletion.

  • 404 Not Found: If the finder with the specified ID does not exist.

  • 4XX/5XX: Returns an error message if the request fails.