tunahanertekin
commented
3 years ago User Related Requests
Default Register (Add User)
It is written to add users database with default register method. (email and password)
Request
- Type: POST
- URL: /api/users
| Body Parameter | Description | Obligation |
|---|---|---|
| name | User's name in string format. | Yes |
| surname | User's surname in string format. | Yes |
| password | User's password in string format. | Yes |
| User's email address in string format. | Yes | |
| phone | User's phone number in string format. | Yes |
Response
-
In success, user data is returned.
{ "status": "SUCCESS", "message": "new user is added", "user": { "user_id": "20", "name": "Ali", "surname": "Yılmaz", "email": "example@gmail.com", "phone": "+905065065566" } } -
In failure, an error message is returned.
{ "status": "FAILURE", "message": "request body fields are not true" }
Default Login
In default login process, users posts their email and password and in return, they get a session key they can use to send their other requests. For development, you can assume that "session_key": "admin".
Request
- Type: POST
- URL: /api/users/login
| Body Parameter | Description | Obligation |
|---|---|---|
| User's email address in string format. | Yes | |
| password | User's password in string format. | Yes |
Response
- In success, a session key is returned for further requests.
{
"status": "SUCCESS",
"message": "login is successful",
"user": {
"user_id": "2",
"name": "Işıl",
"surname": "Güneş",
"email": "igunes@gmail.com",
"phone": "+905435586504"
},
"session": {
"start_time": "Thu Mar 18 2021 22:09:41 GMT+0300 (GMT+03:00)",
"expire_time": "Fri Mar 19 2021 10:09:41 GMT+0300 (GMT+03:00)",
"session_key": "admin"
}
}- In failure, an error message is returned.
{ "status": "SUCCESS", "message": "login has failed" }
## Login Using OAuth
It is written to make users be able to login with their Gmail account. If it's their first login with a Google account, they will be registered and given a `session_key`. If not, their credentials will be checked and they will be given a `session_key` if their credentials hold.
### Request
- Type: POST
- URL: /api/users/google-auth
| Body Parameter | Description | Obligation
| ------------- | ------------- | -------------
| access_token | Access token returned by Google/Firebase. | Yes
### Response
- In success, user & session credentials are returned.
```json
{
"status": "SUCCESS",
"message": "user is logged in using a google account",
"user": {
"user_id": 22,
"name": "discuss",
"surname": "bank",
"email": "connectionbauphi@gmail.com",
"phone": "",
"password": "6181738008c985a1b5f106b796c98e719efcc3c0ff68ddcd14a049825f4900a8",
"registration_id": "notset",
"is_oauth_user": true,
"google_sub_id": "108797461518181707543"
},
"session": {
"user_id": 22,
"session_key": "6Oul3E",
"start_time": "2021-04-15T17:18:57.110Z",
"expire_time": "2021-04-16T05:18:57.110Z"
}
}- In failure, an error message is returned
{ "status": "FAILURE", "message": "request body fields are not true" }
Update User
It is written to update users' data.
Request
- Type: PATCH
- URL: /api/users/:id
| Header Parameter | Description | Obligation |
|---|---|---|
| session_key | Session key for user. (use "admin") |
Yes |
| Body Parameter | Description | Obligation |
|---|---|---|
| name | User's name in string format. | No |
| surname | User's surname in string format. | No |
| password | User's password in string format. | No |
| User's email address in string format. | No | |
| phone | User's phone number in string format. | No |
Response
- In success, only the changed fields are visible.
{ "status": "SUCCESS", "message": "user is updated", "user": { "user_id": "9", "name": "Ali", "surname": "Yılmaz", "password": "12345678", "email": "example@gmail.com", "phone": "+905065065566" } } - In failure, an error message is returned
{ "status": "FAILURE", "message": "request body fields are not true" }
Delete User
It is written to delete users from database.
Request
- Type: DELETE
- URL: /api/users/:id
| Header Parameter | Description | Obligation |
|---|---|---|
| session_key | Session key for user. (use "admin") |
Yes |
Response
- In success, deleted users' data is returned.
{ "status": "SUCCESS", "message": "user is deleted", "user": { "user_id": "9", "name": "Ali", "surname": "Yılmaz", "email": "example@gmail.com", "phone": "+905055550505" } } - In failure, an error message is returned.
{ "status": "FAILURE", "message": "user is not found" }
BauPhi API Usage & Backend Documentation
API is accessible in Heroku.
Recent Updates (from newest to oldest):
is_pets_allowedfield is added to the Home. It isfalseas default.Requestkeyword is changed withInteraction, some endpoints are changed in home offers/requests.isVisiblefield is added.Index
Mobile Notifications
Functional Usage
Test Endpoint
Generic Requests
List Event Participants
AutoLocation Using 3rd Party API
List Close Homes
List Close Events
Get User Details (For Development Usage)
Get All Homes (For Development Usage)
Get All Events (For Development Usage)
Get All Announcements (For Development Usage)
Get Last Earthquakes
Get All Money Donations
User Related Requests
Default Register (Add User)
Default Login
Login Using OAuth
Update User
Delete User
Home Related Requests
Get Homes
Add Home
Update Home
Delete Home
Send Offer (Victim-Volunteer Interaction)
Reject Offer (Victim-Volunteer Interaction)
Delete Offer (Victim-Volunteer Interaction)
List Offers Sent (Victim-Volunteer Interaction)
List Offers Received (Victim-Volunteer Interaction)
Event Related Requests
Get Events
Get Event
Add Event
Update Event
Delete Event
Join Event
Cancel Event Participation
Announcement Related Requests
Get Announcements
Get Announcement
Add Announcement
Update Announcement
Delete Announcement