Supported HTTP Methods
Request methods supported by Wealthtech API
Wealthtech API 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.
Summary
Operation | Request method | Resource endpoint | Parameters / Payload |
---|---|---|---|
Create Single object | POST | / | Json object in body |
Create Several objects | POST | /create-many | Array of json objects in body |
Read All objects, paged | GET | / | Pagination and simple filters in query string parameters |
Read Single object | GET | /{id} | Object ID as url parameter |
Read Filter objects | GET | /filter | Complex filters in json payload |
Update Single object | PUT | /{id} | Full object as json in body |
Update Several objects | PUR | / | Array of objects as json in body |
Delete Single object | DELETE | /{id} | None |
Delete Multiple objects | DELETE | / | Array of ids as json in the body |
Unsupported request methods
The following http verbs are unsupported. Usage of these verbs will result in a 405 - Method not allowed error:
OPTIONS
HEAD
PATCH
is used for partially modify a resource. However it's unsupported on Atlas. Use thePUT
method to update objects, which requires providing the full object.TRACE
CONNECT
Updating Data
The http PATCH
method is designed for partial updates, and is unsupported by the Atlas API. Instead, you must use the PUT
method for full object replacement when you want to update data.
A PUT
request is for 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. Those that are will take on the new values provided in the PUT
request. However, not all endpoints support the PUT
method. Those that don't are not mutable data. Examples include balances, transactions, positions, holdings, etc.
Most endpoints allow you to update a single object or multiple objects, using a PUT
method for both cases.
Updated 4 months ago