Services Search

Component ID

1261762

Component name

Services Search

Component type

module

Maintenance status

Development status

Component security advisory coverage

covered

Downloads

3545

Component created

Component changed

Component body

This module provides a Services resource that enables a remote application to search for content and users on your site using Drupal core's search features. It's developed for Services 7.x-3.x as a reimplementation of the search service that was available in Services 6.x-2.x. If someone wants to help maintain this project going forward, they're more than welcome!

Requirements

  • Services 7.x-3.x
    (The 3.0 version is incompatible with Services 7.x-3.2 and later. Please use the -dev version and report your results here.)

Usage

To expose your site's search feature as a JSON REST service, follow these steps:

  1. Create a new Services endpoint with a path of your choice, e.g. services. Choose the REST server.
  2. Edit the endpoint's resources and check search_node and/or search_user.
  3. Edit the server settings and choose JSON as formatter.
  4. Try the service's URLs in a browser:
    • http://my.server.com/services/search_node/retrieve.json?keys=test for content search.
    • http://my.server.com/services/search_node/retrieve.json?keys=test&simple=1 for content search with a simpler result format.
    • http://my.server.com/services/search_user/retrieve.json?keys=name for user search.

Credits

Based on the search service in the 6.x version of Services. Development supported by RFSU (Swedish Association for Sexuality Education) and SthlmConnection.