The various actions on a resource
Introduction
Our APIs comply with the HTTP verbs and their correspondence with the CRUD actions (Create, Read, Update, Delete) of a resource. However, it is also possible to perform all of the actions only with HTTP GET requests or only with HTTP POST requests. To do this, the action to be performed must be specified in the URL.
| Description of the action | Dedicated HTTP verb | Name of the action |
|---|---|---|
| Read resources | GET | read |
| Create a resource | POST | create |
| Update resources | PUT | update |
| Delete resources | DELETE | delete |
Example
The two following Curl requests are considered to be equivalent by our APIs:
| curl -X GET -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...ccOqbVow8xOQyQ" https://api.messengeo.net/rest/ressource |
| curl -X POST -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...ccOqbVow8xOQyQ" https://api.messengeo.net/rest/ressource?action=read |
Methods profile for each action
| Description of the action | input | output |
|---|---|---|
|
read |
Filter |
List of resources |
|
create |
Parameters |
Resource created |
|
update |
Filter + Parameter |
Number of resources updated |
|
delete |
Filter |
Number of resources deleted |