Skip to content
Find file History
Latest commit 237473a Nov 6, 2013 @pborreli pborreli Fixed typo
..
Failed to load latest commit information.
README.md Fixed typo Nov 6, 2013

README.md

Drupal Services Overview

This document provides examples and resources for creating resources via the Services module, according to the Whitehouse API Standard.

Exposing new resources directly via Services

Implement hook_services_resources(). Define either new operations, actions, or targeted actions as per hook documentation.

Note that when you define new CRUD operations, services will automatically expose new URLs for the new resource according to the following pattern:

  • Create: POST /[endpoint_path]/[resource] + body data
  • Retrieve: GET /[endpoint_path]/[resource]/[resource_id]
  • Update: PUT /[endpoint_path]/[resource]/[resource_id] + body data
  • Delete: DELETE /[endpoint_path]/[resource]/[resource_id]

Be sure that your endpoint path conforms to the Whitehouse API Standards: [endpoint_path] = /api/[version]/

These default URL patterns necessitate a default, corresponding argument structure. For example:

  • CREATE operations expect argument ‘source’ to be defined as ‘data’
  • UPDATE operations expect at least two arguments, one with 'source' defined as 'path', and one with 'source' defined as 'data'
  • Etc.

Resources

Something went wrong with that request. Please try again.