Skip to content

Suggested call flow for client

Varun Patil edited this page Mar 4, 2018 · 14 revisions

Client stores user uuid

The client only needs to know the endpoint to get the user profile, and the rest of the API can be navigated with the returned hyperlinks (see HATEOAS if you're unfamiliar with this).

Call Flow:

  • Client start --> request user profile (detailed) --> request each body followed (from nested links) --> construct a local database of events recursively, since events returned will have duplication --> construct news feed etc.
  • User clicks on event --> get event (detailed) --> display interested users etc. (if necessary) along with other information contained in the response ?--> user clicks on a user --> request user (detailed)

Note:

It is by design that a lot of redundant data will be returned with each request. The goal is to minimize the number of RTTsand have minimal interaction between the views of the client application.

TODO:

  • Return a flag with followed bodies of the user if the body is a child of another body the user follows to prevent duplicate queries.
  • Implement an endpoint to get locations without detailed information of all events for map construction.
Clone this wiki locally