stoney core: Customers Resource - REST API

From stoney cloud
Revision as of 11:46, 21 February 2014 by Michael (Talk | contribs)


Jump to: navigation, search

Overview

The REST API describes the (Representational State Transfer Application Programming Interface) of the customers resource to be used by stoney core, stoney conductor and other Self-Service Modules or third party applications.

Basically, we want to be able to do the following things:

  • Create a new customer (POST).
  • Retrieve multiple customers in the form of a list (GET).
  • Retrieve a single customer (GET).
  • Update an existing customer (PUT).
  • Update one or more values of an existing customer (PATCH).
  • Delete a single customer (DELETE).

To get an idea what happens behind the screens, have a look at the stoney core: Customers Resource Mapping (REST - LDAP) documentation located in the Mapping (REST - LDAP) category.