Account
| API | Description |
|---|---|
| POST api/v1/account/ChangePassword |
No documentation available. |
| POST api/v1/account/SetPassword |
No documentation available. |
| POST api/v1/account/AddExternalLogin |
No documentation available. |
| POST api/v1/account/RemoveLogin |
No documentation available. |
| GET api/v1/account/ExternalLogin?provider={provider}&error={error} |
No documentation available. |
| GET api/v1/account/ExternalLogins?returnUrl={returnUrl}&generateState={generateState} |
No documentation available. |
| POST api/v1/account/register |
Register Updated in Beta 0.2 |
| POST api/v1/account/RegisterExternal |
Registers a third party authentication. This needs to be called after logging in as the third party (i.e. Facebook, Twitter). This will associate the inviteeMember's oAuth claim with their email address and will add their member info to the system. |
| POST api/v1/account/SocialLogin |
Login to the app using social login This is going to result in two successful options. These can be determined by the json loggedIn property 1. The user is registered and will be logged in and provided with a valid access token to use for authentication 2. The user is not registered. They will be returned a temp access code that will allow them to register. |
| POST api/v1/account/SocialRegister |
Register to the app This returns a new valid application oAuth token if successful. |
| POST api/v1/account/forgotpassword |
Forgot Password 1. Generate reset password code (new guid without dashes) and reset valid until date - UTC (15 minutes from request time) 2. Send an email with a direct url to the reset password endpoint (email and reset password code) Beta 0.2 - emails full url - page exists |
| PUT api/v1/account/profile/set |
Updates the inviteeMember's profile. Beta 0.6 - added ShowRealName option, return MemberDetailWithDashboard Beta 0.9 - added member follower notification |
| PATCH api/v1/account/profile/set |
Updates the inviteeMember's profile. Beta 0.6 - added ShowRealName option, return MemberDetailWithDashboard Beta 0.9 - added member follower notification |
| DELETE api/v1/account/delete |
Deletes the account. - Removes all personal information, sets funname and email to generic removed account name and sets is active to false Beta 9/30 |
| GET api/v1/account/profile/get |
Gets the logged in user's information Beta 0.8 - show notification settings Beta 0.9 - added member follower notification |
| POST api/v1/account/profile/setavatar |
Sets the inviteeMember's avatar Beta 0.2 |
| POST api/v1/account/profile/setbackground |
Sets the member's background image Beta 0.2 |
| POST api/v1/account/device/add |
Register the member's device (if it hasn't already been registered) Beta 0.2 Beta 10/5 - return device id |
| GET api/v1/account/dashboard/get/notifications |
Gets the unread notification details Beta 0.4 |
| GET api/v1/account/dashboard/get/deadlines |
Gets the unread deadline details Beta 0.4 |
| GET api/v1/account/dashboard/get/invites |
Gets the unread member game invites Beta 8/27 |
| GET api/v1/account/dashboard/get/connectionrequests |
Gets the pending connection requests Beta 9/15 |
| POST api/v1/account/dashboard/viewed/deadline/{id} |
Sets the notification or deadline as viewed (it won't be returned by the corresponding get call) Beta 0.4 |
| POST api/v1/account/dashboard/viewed/notification/{id} |
Sets the notification or deadline as viewed (it won't be returned by the corresponding get call) Beta 0.4 |
| POST api/v1/account/dashboard/viewed/invite/{id} |
Sets the notification or deadline as viewed (it won't be returned by the corresponding get call) Beta 0.4 |
| POST api/v1/account/dashboard/viewed/notifications/all |
Sets all the notifications as viewed Beta 8/26 |
| POST api/v1/account/dashboard/viewed/deadlines/all |
Sets all the deadlines as viewed Beta 8/26 |
| POST api/v1/account/dashboard/viewed/invites/all |
Sets all the invites as viewed Beta 8/26 |
| GET api/v1/account/funnameavailable/new/{funName} |
Checks if the fun name is available for a new registration Beta 9/9 |
| GET api/v1/account/funnameavailable/update/{funName} |
Checks if the fun name is available for an update Beta 9/9 |
| GET api/v1/account/inviteurl |
Gets the member's unique invitation url |
| POST api/Account |
No documentation available. |
Points
The points controller. This is used to get points and leaderboard data
| API | Description |
|---|---|
| GET api/v1/points/leaderboard/{category}/{year} |
Get leaderboard data by leaderboard grouping. Return first 20 per category. Release beta 0.2 |
| GET api/v1/points/leaderboard/member/{memberId} |
Get leaderboard data by leaderboard grouping. Return first 20 per category. Added beta 8/24 |
| GET api/v1/points/pointsactivity/{memberId}/{year} |
Gets the points - either all of them or the points for the specified year Beta 0.5 |
| GET api/v1/points/pointsactivity/{memberId} |
Gets the points - either all of them or the points for the specified year Beta 0.5 |
| GET api/v1/points/topranked |
Gets the top 100 members ordered by rank Beta 0.5 |
| GET api/v1/points/toprankedconnections |
Gets the top 100 connections for the logged in member, ordered by rank. NOTE: this could return 101 connections if the member has over 100 connections and he's not in the top 100 5/24/16 |
| GET api/v1/points/topmovers |
Gets the top 100 members ordered by movement Beta 0.5 |
| GET api/v1/points/performance/{memberId} |
Gets the performance for the specified member Released Beta 0.6 |
| GET api/v1/points/performance/{memberId}/{year}?yearId={yearId} |
Gets the performance for the specified member and year Released Beta 0.6 |
Social
The social controller. Used to manage social details - connections, Pods, following
| API | Description |
|---|---|
| POST api/v1/social/follow/{memberId} |
Follow a given member Released: Beta 0.2 |
| POST api/v1/social/unfollow/{memberId} |
Unfollows the member Released: Beta 0.2 |
| PUT api/v1/social/pods/set |
Updates the pod details (currently just the pod name). Beta 0.2 |
| PATCH api/v1/social/pods/set |
Updates the pod details (currently just the pod name). Beta 0.2 |
| GET api/v1/social/pods/get |
Gets the list of Pods Beta 0.3 Beta 9/9: Added pod counts |
| GET api/v1/social/pods/detail/{podId} |
Gets the pod details Beta 0.3 Beta 0.9: Added pods per member Beta 12/2: Added RankingTier |
| DELETE api/v1/social/pods/removemember/{podId}/{memberId} |
Removes the member from the pod Still need to test pod management functions |
| PATCH api/v1/social/pods/setpodsformember |
Updates the member's pods |
| POST api/v1/social/connect/request |
Request to connect with the specified user and add the member to the specified Pods. Max of 200 people per pod - pending invites count towards total Beta 0.4 |
| POST api/v1/social/connect/response |
Accept or deny the connection request Beta 0.4 Beta 9/10 - remove the associated notifications on response |
| POST api/v1/social/connect/remove/{memberId} |
Remove the connection request Beta 0.4 - notifications ready |
| POST api/v1/social/invite |
Invites the emails to the app Beta 0.4: Note - the destination invitation url doesn't exist yet |
| POST api/v1/social/search?searchData={searchData} |
Searches for members based on the search input Beta 0.4 - initial search needs performance improvements and additional search fields |
| GET api/v1/social/followers |
Gets the members followers Beta 0.8 |
| GET api/v1/social/following |
Gets the members that you're following Beta 0.8 |
| GET api/v1/social/connections |
Gets the members connections Beta 0.8 Beta 9/21: added pods Beta 10/15: added IsPendingConnection status |
| GET api/v1/social/connections/{excludePending} |
Gets the members connections Beta 0.8 Beta 9/21: added pods Beta 10/15: added IsPendingConnection status |
| GET api/v1/social/suggestions |
Gets suggested connections Beta 0.9 |
| GET api/v1/social/profile/{memberId} |
Gets the requested member's information Release 8/21: added social relationship info Release 8/26: added total points |
News
The news controller. This is used to get news data
| API | Description |
|---|---|
| GET api/v1/news/navigation |
No documentation available. |
Contests
The contests controller
| API | Description |
|---|---|
| GET api/v1/contests/get/{gameId} |
Get contest details by the game id |
| POST api/v1/contests/join |
Joins the contest 11/9/16 - added |
Games
The games controller. This is used to get game details
| API | Description |
|---|---|
| GET api/v1/games/get |
Gets all active games with deadlines after the current time |
| GET api/v1/games/detail/{id} |
Get the game details specified by the game id Beta 0.4: Added HasPublicMemberGames |
| GET api/v1/games/participants/{gameId} |
Gets the game participants / contestants for the specified game id |
| GET api/v1/games/participantscores/{gameId} |
Gets the game participant scores for the specified game id |
| GET api/v1/games/archive/{categoryId} |
Gets all archived games with past deadlines Beta 9/9 |
| GET api/v1/games/archive/{categoryId}/{year} |
Gets all archived games with past deadlines Beta 9/9 Beta 9/14: added year filter |
| GET api/v1/games/archivebyevent/{eventId}/{year} |
Gets all archived games by event / year |
Test
A very simple test controller to test an authenticated and non-authenticated call Zac Change
| API | Description |
|---|---|
| GET api/test/TestAuthenticated |
Just used to test if you're authenticated. Will respond with "You're logged in as {{username}}" |
| GET api/test/TestUnauthenticated |
Just used to test if the api is responding. Will respond with "Hi" |
| GET api/test/TestNotification/{memberId} |
No documentation available. |
| GET api/test/TestLog |
No documentation available. |
| GET api/test/TestError |
No documentation available. |
| GET api/test/CreateSampleInviteNotifications/{memberId} |
No documentation available. |
MemberGames
The memberGame controller. Used to manage member memberGame
| API | Description |
|---|---|
| GET api/v1/membergames/get/{filter} |
Gets all of the member memberGame based on the input filter Beta 0.4 - added TotalPlayers |
| GET api/v1/membergames/get/{filter}/{gameId} |
Gets all of the member memberGame based on the input filter Beta 0.4 - added TotalPlayers |
| GET api/v1/membergames/get-available/{gameId} |
Gets all of the member games that are available |
| GET api/v1/membergames/get-managing/{gameId} |
Gets all of the member games that you're managing |
| GET api/v1/membergames/get-playing/{gameId} |
Gets all of the member games that you're playing |
| GET api/v1/membergames/getinactive/{filter}/{gameId} |
Gets all of the inactive member games based on the input filter Beta 0.3 |
| GET api/v1/membergames/getallmanage/{gameId}/{currentMemberGameId} |
Gets all of the member games that the user has managed or is managing Beta 11/11 Beta 11/22 > add currentMemberGameId filter |
| GET api/v1/membergames/detail/{id} |
Get the member memberGame specified by the member memberGame id Beta 0.8 - added managers message and rules Beta 0.9 - added owner avatar and fun name 10/12/16 - returning contest info too |
| POST api/v1/membergames/create |
Creates the memberGame Beta 11/17: Enforce member game name as defined |
| PUT api/v1/membergames/update |
Updates the memberGame Supports put or patch Beta 0.9: added manager message notification flag and login |
| PATCH api/v1/membergames/update |
Updates the memberGame Supports put or patch Beta 0.9: added manager message notification flag and login |
| DELETE api/v1/membergames/delete/{id} |
Deletes the memberGame |
| POST api/v1/membergames/member/setpicks |
Sets the member picks. Can set pick1, 2 or 3 separately. Beta 8/24: enforced no dupes start / end date |
| POST api/v1/membergames/availableparticipants |
Gets the available participants for a no-dupes game. Beta 8/25: |
| POST api/v1/membergames/join |
Joins the member memberGame Beta 8/25: return MemberGameDetailExtended |
| DELETE api/v1/membergames/manage/{memberGameId}/deletemember/{memberId} |
Removes the member from the member game - removes all aliases. This can only be called by the game owner |
| GET api/v1/membergames/publicarchive/{gameId} |
Gets the archive of the public member games that have completed for the specified game |
| GET api/v1/membergames/member/getpicks/{memberGameId} |
Gets the member's picks for the specified game id |
| GET api/v1/membergames/memberscores/{memberGameId} |
Gets the member scores for the specified member game id |
| POST api/v1/membergames/invite |
Invites the specified members Beta 0.4: Initially implemented needs to be tested in detail |
Internal
Utility controller for internal calls
| API | Description |
|---|---|
| GET api/internal/runnotifications |
Endpoint to trigger the db notifications queue Beta 0.7 |
| GET api/internal/runnotifications/{password} |
Endpoint to trigger the db notifications queue with config password auth Beta 0.7 |
| GET api/internal/cleanupazureimages |
No documentation available. |
| GET api/internal/setazureimagecacheheaders |
Sets all the azure image cache headers to the hard coded value |
Events
The events controller. This is used to manage events
| API | Description |
|---|---|
| GET api/v1/events/get |
Gets all events |
| GET api/v1/events/detail/{id} |
Gets the specified event |
| GET api/v1/events/archive |
Gets all events with archived game |