sigonasr2/family-tracker
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
sigonasr2, Sig, Sigo 2020-07-29 04:55:12 +09:00 committed by GitHub
parent a53f4ea084
commit 2338ecec39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -19,24 +19,41 @@ An application that allows a family to track family members via live tracking an
- As a user, I should be warned if a location I am going to is suspicious or susceptible to danger. - As a user, I should be warned if a location I am going to is suspicious or susceptible to danger.
## Data Endpoints ## Data Endpoints
All endpoints require an `authentication token` provided by your mobile tracking device upon registration. They must be passed in as a parameter for all endpoints as `?auth=XXXXXXX` `GET /family` - Gets all family profiles. Each family profile contains a `members` object. Sample output:
```[{"id":1,"name":"Test","members":[]},{"id":2,"name":"Sigona","members":[{"id":1,"firstName":"Joshua","lastName":"Sigona","mobileDeviceId":43891005},{"id":2,"firstName":"Michelle","lastName":"Sigona","mobileDeviceId":16829175},{"id":3,"firstName":"Joseph","lastName":"Sigona","mobileDeviceId":65881096},{"id":4,"firstName":"Jonathan","lastName":"Sigona","mobileDeviceId":99971653},{"id":5,"firstName":"Robert","lastName":"Sigona","mobileDeviceId":987198324598},{"id":6,"firstName":"Son Yong","lastName":"Sigona","mobileDeviceId":87657155}]}]```
`GET /family` - Gets all family profiles. Each family profile contains a `member` object. `POST /family` - Adds a new family. Required: ```@RequestBody:
name - Name of new family.```
`GET /family/{name}` - Get a family by name. `POST /member/create` - Adds a new family. Required: ``` * @RequestBody requires:
* firstName - First Name of family member.
* lastName - Last Name of family member.
* mobileId - ID of mobile device.```
`GET /member/{firstname}/{lastname}` - Gets a family member by first and last name. `POST /relationship/{familyid}/{memberid}/{relationship}` - Establish a new relationship between a member and its family. Valid relationships are: `Parent/Mother/Father/Brother/Sister`
`GET /member/{firstname}/{lastname}/location` - Gets current location of a member. `DELETE /relationship/{familyid}/{memberid}` - Removes a created relationship from a member.
`POST /member/{firstname}/{lastname}` - Register a new member with a mobile device. `DELETE /member/{id}` - Deletes a member by id. Removes all established relationships of this member as well.
`POST /member/{firstname}/{lastname}/location` - Checks into a new location. `POST /location` - Records a new location a member is currently at. Will automatically notify the appropriate users about dangerous locations as well as notify parents of their childrens' whereabouts. Required: ```@RequestBody:
* member - The member posting this location.
* x - The X coordinate of the location (latitude).
* y - The Y coordination of the location (longitude).```
`PATCH /member/{firstname}/{lastname}/location` - Update current location statistics. `POST /knownlocation` - Records a new known location. Required: ```@RequestBody
* name - The name of the location.
* x - The X coordinate of the location (longitude).
* y - The Y coordination of the location (latitude).
* safe - True if safe, false if unsafe location.```
`PATCH /member/{firstname}/{lastname}/type` - Updates a member type. Valid types include `parent`,`user`, and `admin`. `DELETE /knownlocation/{id}` - Deletes a known location by id.
`DELETE /family/{family}` - Removes a family. `GET /notification/{memberid}` - Gets the notifications a user has by member id.
`DELETE /family/{family}/member/{firstname}/{lastname}` - Removes family member from a family. `POST /notification` - Posts a new notification to a user from another user. Required: ```@RequestBody
* fromMember - The ID of the member sending the notification.
* toMember - The ID of the member receiving the notification.
* message - The message.```
`DELETE /notification/{notificationid}` - Deletes a notification by id.