Difference between revisions of "stoney core: Customers Resource - REST API"
From stoney cloud
| [unchecked revision] | [unchecked revision] |
(Created page with "= Overview = The REST API describes the ('''Re'''presentational '''S'''tate '''T'''ransfer '''A'''pplication '''P'''rogramming '''I'''nterface) of the customers resource to be...") |
(→Overview) |
||
| Line 10: | Line 10: | ||
* Delete a single customer (DELETE). | * Delete a single customer (DELETE). | ||
| − | To get an idea what happens behind the screens, have a look at the [[stoney core: | + | 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 [[:Category:Mapping (REST - LDAP)|Mapping (REST - LDAP)]] category. |
[[Category:REST API]][[Category:stoney core]] | [[Category:REST API]][[Category:stoney core]] | ||
Revision as of 11:46, 21 February 2014
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.
