-
Notifications
You must be signed in to change notification settings - Fork 7
API v0.1.1
Denys edited this page Apr 10, 2020
·
5 revisions
Alpha version, before Swagger
All API has base URL /api
Method | URL | RequestBody | Response | Comment | Role |
---|---|---|---|---|---|
Organization | |||||
GET | /organizations?search= | get organizations can be filtered by status | admin | ||
PUT | /organizations/{id} | update organization status to verified or blocked and send according email to supervisor |
admin | ||
POST | /organization_sign_up | creates organization record and supervisor record with new status |
supervisor | ||
POST | /organization_confirm?token= | finds user by token and changes organization and user statuses to active
|
any | ||
GET | /my_organization | get detailed info of supervisor's organization | supervisor | ||
PUT | /my_organization | update supervisor's organization | supervisor | ||
OrderRequest | |||||
GET | /requests?search= | - | Search Requests ( by item name, by location, by beneficiary name, by organization name, by creator). | supervisor | |
GET | /requests/{id} | - | get requqest by id | supervisor | |
POST | /requests | supervisor | |||
PUT | /requests/{id} | Update request | supervisor | ||
PUT | /requests/{id}/status | Update request status | supervisor | ||
DELETE | /requests/{id} | Delete request | supervisor | ||
GET | /items?search= | Search Items ( by item name, by location, by beneficiary name, by organization name). Alternative GET /search?q='' | any | ||
POST | /propose_help | guest fills up the form with contact data, this data will be visible in supervisor's dashboard | any | ||
GET | /beneficiaries?search= | - | search for beneficiary by region county and postal code used when creating request | supervisor |
TBD:
search response pagination
contact person of request is different from current user
partial coverage of request
price of items