|
|
All the endpoints belong to the `api` namespace, meaning all the follwing URL are prefixed with `/api/`. So the URL to use follows the scheme:
|
|
|
```
|
|
|
https://<hostname>/api/<endpoint>
|
|
|
```
|
|
|
|
|
|
*Note that some methods are stroke as they are not activated right now but are ready to be*
|
|
|
|
|
|
# Model-based endpoints
|
|
|
|
|
|
## Cotisations
|
|
|
|
|
|
|
|
|
### /cotisations/facture/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all invoices | Retrieve the list of all invoices | N/A | N/A |
|
|
|
| ~~POST~~ | ~~- Can view the api<br \>- Can create an invoice~~ | ~~Create a new invoice~~ | ~~N/A~~ | ~~fields to create an invoice~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/facture/\<id\>/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all invoices<br \>- Can view this invoice | Retrieve the data about this invoice | N/A | N/A |
|
|
|
| ~~DELETE~~ | ~~- Can view the api<br \>- Can delete this invoice~~ | ~~Delete this invoice~~ | ~~N/A~~ | ~~N/A~~ |
|
|
|
| ~~PATCH~~ | ~~- Can view the api<br \>- Can edit this invoice~~ | ~~Edit this invoice partially~~ | ~~N/A~~ | ~~the fields of an invoice you want to modify~~ |
|
|
|
| ~~PUT~~ | ~~- Can view the api<br \>- Can edit this invoice~~ | ~~Edit this invoice entirely~~ | ~~N/A~~ | ~~all the fields of an invoice~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/vente/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all purchases | Retrieve the list of all purchases | N/A | N/A |
|
|
|
| ~~POST~~ | ~~- Can view the api<br \>- Can create a purchase~~ | ~~Create a new purchase~~ | ~~N/A~~ | ~~fields to create a purchase~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/vente/\<id\>/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all purchases<br \>- Can view this purchase | Retrieve the data about this purchase | N/A | N/A |
|
|
|
| ~~DELETE~~ | ~~- Can view the api<br \>- Can delete this purchase~~ | ~~Delete this purchase~~ | ~~N/A~~ | ~~N/A~~ |
|
|
|
| ~~PATCH~~ | ~~- Can view the api<br \>- Can edit this purchase~~ | ~~Edit this purchase partially~~ | ~~N/A~~ | ~~the fields of a purchase you want to modify~~ |
|
|
|
| ~~PUT~~ | ~~- Can view the api<br \>- Can edit this purchase~~ | ~~Edit this purchase entirely~~ | ~~N/A~~ | ~~all the fields of a purchase~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/article/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all articles | Retrieve the list of all articles | N/A | N/A |
|
|
|
| ~~POST~~ | ~~- Can view the api<br \>- Can create an article~~ | ~~Create a new article~~ | ~~N/A~~ | ~~fields to create an article~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/article/\<id\>/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all articles<br \>- Can view this article | Retrieve the data about this article | N/A | N/A |
|
|
|
| ~~DELETE~~ | ~~- Can view the api<br \>- Can delete this article~~ | ~~Delete this article~~ | ~~N/A~~ | ~~N/A~~ |
|
|
|
| ~~PATCH~~ | ~~- Can view the api<br \>- Can edit this article~~ | ~~Edit this article partially~~ | ~~N/A~~ | ~~the fields of an article you want to modify~~ |
|
|
|
| ~~PUT~~ | ~~- Can view the api<br \>- Can edit this article~~ | ~~Edit this article entirely~~ | ~~N/A~~ | ~~all the fields of an article~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/banque/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all banks | Retrieve the list of all banks | N/A | N/A |
|
|
|
| ~~POST~~ | ~~- Can view the api<br \>- Can create a bank~~ | ~~Create a new bank~~ | ~~N/A~~ | ~~fields to create a bank~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/banque/\<id\>/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all banks<br \>- Can view this bank | Retrieve the data about this bank | N/A | N/A |
|
|
|
| ~~DELETE~~ | ~~- Can view the api<br \>- Can delete this bank~~ | ~~Delete this bank~~ | ~~N/A~~ | ~~N/A~~ |
|
|
|
| ~~PATCH~~ | ~~- Can view the api<br \>- Can edit this bank~~ | ~~Edit this bank partially~~ | ~~N/A~~ | ~~the fields of a bank you want to modify~~ |
|
|
|
| ~~PUT~~ | ~~- Can view the api<br \>- Can edit this bank~~ | ~~Edit this bank entirely~~ | ~~N/A~~ | ~~all the fields of a bank~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/paiement/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all payments | Retrieve the list of all payments | N/A | N/A |
|
|
|
| ~~POST~~ | ~~- Can view the api<br \>- Can create a payment~~ | ~~Create a new payment~~ | ~~N/A~~ | ~~fields to create a payment~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/paiement/\<id\>/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all payments<br \>- Can view this payment | Retrieve the data about this payment | N/A | N/A |
|
|
|
| ~~DELETE~~ | ~~- Can view the api<br \>- Can delete this payment~~ | ~~Delete this payment~~ | ~~N/A~~ | ~~N/A~~ |
|
|
|
| ~~PATCH~~ | ~~- Can view the api<br \>- Can edit this payment~~ | ~~Edit this payment partially~~ | ~~N/A~~ | ~~the fields of a payment you want to modify~~ |
|
|
|
| ~~PUT~~ | ~~- Can view the api<br \>- Can edit this payment~~ | ~~Edit this payment entirely~~ | ~~N/A~~ | ~~all the fields of a payment~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/cotisation/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all cotisations | Retrieve the list of all cotisations | N/A | N/A |
|
|
|
| ~~POST~~ | ~~- Can view the api<br \>- Can create a cotisation~~ | ~~Create a new cotisation~~ | ~~N/A~~ | ~~fields to create a cotisation~~ |
|
|
|
|
|
|
|
|
|
### /cotisations/cotisation/\<id\>/
|
|
|
|
|
|
| Method | ACL required | Effect | Params | Data |
|
|
|
| ------ | ------------ | ------ | ----- | ---- |
|
|
|
| GET | - Can view the api<br \>- Can view all cotisations<br \>- Can view this cotisation | Retrieve the data about this cotisation | N/A | N/A |
|
|
|
| ~~DELETE~~ | ~~- Can view the api<br \>- Can delete this cotisation~~ | ~~Delete this cotisation~~ | ~~N/A~~ | ~~N/A~~ |
|
|
|
| ~~PATCH~~ | ~~- Can view the api<br \>- Can edit this cotisation~~ | ~~Edit this cotisation partially~~ | ~~N/A~~ | ~~the fields of a purchase you want to modify~~ |
|
|
|
| ~~PUT~~ | ~~- Can view the api<br \>- Can edit this cotisation~~ | ~~Edit this cotisation entirely~~ | ~~N/A~~ | ~~all the fields of a cotisation~~ |
|
|
|
|
|
|
|
|
|
## Machines
|
|
|
|
|
|
## Preferences
|
... | ... | |