This repository was archived by the owner on Aug 9, 2020. It is now read-only.
Friends
This ASP.NET Core Service allows a client to discover other users as friends via phone-numbers. It's a very simple API, so let's get straight in to the meat:
While the API allows a granular query for users, it is wise to just post an array of phone-numbers to the endpoint and filter the result on the client side. This will in many cases reduce HTTP requests and greatly improve the UX for the user.
| URL | Method | Params | Success | Error |
|---|---|---|---|---|
| /friends/ | GET | ?=phonenumber | OKResult(json) | Not Found |
| /friends/ | POST | json[phonenumbers] | OKResult(json[]) | Not Found |
| /friends/{phoenNumber}/name | GET | OkResult(name) | Not Found | |
| /friends/{phoenNumber}/status | GET | OkResult(status) | Not Found | |
| /friends/check/ | GET | ?=phonenumber | Ok | Not Found |