Supported HTTP Methods
WealthTech API platform supports the classic CRUD database operations: Create, Read, Update, Delete. Each of these operations has a corresponding request method: POST, GET, PUT and DELETE, respectively.
Below is a list of supported methods and endpoints description:
| Operation | Request Method | Resource Endpoint | Parameters / Payload |
|---|---|---|---|
| Create Single object | POST | / | JSON object in the request body |
| Create Several objects | POST | /create-many | Array of json objects in the body |
| Read All objects, paged | GET | / | Pagination and simple filters in a query string parameters |
| Read Single object | GET | /{id} | Object ID as an URL parameter |
| Read Filter objects | POST | /filter | Complex filters in a json payload |
| Update Single object | PUT | /{id} | Object ID as an URL parameter |
| Update Several objects | PUT | / | Array of objects as a json in the body |
| Delete Single object | DELETE | /{id} | Object ID as an URL parameter |
| Delete Multiple objects | POST | /delete-many | Array of objects IDs as a json in the body |
A PUT request performs the full object replacement. So you must provide full objects with all fields to an endpoint in order to make an update. Not all fields are mutable in our database. Those, which are mutable, will take on the new values provided in the PUT request. However, not all endpoints support the PUT method, meaning this data is not mutable.
Unsupported HTTP Methods
The following HTTP methods are unsupported in the WealthTech API platform. Usage of these methods will result in a "405 - Method Not Allowed" error:
OPTIONSHEADTRACECONNECTPATCH- usually used for partially modify a resource. However it's unsupported by the WealthTech API. Instead, please use thePUTmethod to update objects where supported.
Updated about 1 year ago