Difference between revisions of "stoney core: People Resource - REST API"
From stoney cloud
[unchecked revision] | [unchecked revision] |
(→Overview) |
|||
Line 8: | Line 8: | ||
* Update an existing person (PUT). | * Update an existing person (PUT). | ||
* Update one or more values of an existing person (PATCH). | * Update one or more values of an existing person (PATCH). | ||
− | * Delete a single | + | * Delete a single person (DELETE). |
To get an idea what happens behind the screens, have a look at the [[stoney core: People Resource Mapping (REST - LDAP)]] documentation located in the [[:Category:Mapping (REST - LDAP)|Mapping (REST - LDAP)]] category. | To get an idea what happens behind the screens, have a look at the [[stoney core: People 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 10:46, 21 February 2014
Overview
The REST API describes the (Representational State Transfer Application Programming Interface) of the people 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 person (POST).
- Retrieve multiple people in the form of a list (GET).
- Retrieve a single person (GET).
- Update an existing person (PUT).
- Update one or more values of an existing person (PATCH).
- Delete a single person (DELETE).
To get an idea what happens behind the screens, have a look at the stoney core: People Resource Mapping (REST - LDAP) documentation located in the Mapping (REST - LDAP) category.