Difference between revisions of "Web API/Progress"

From Mania Tech Wiki
Jump to navigation Jump to search
(Created this page.)
 
(fix alphabetic order)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
This page is to keep trace of what has already been documented. The table below lists all known endpoints.
+
This page is to keep trace of what has already been documented. The table below lists all known remote calls.
  
−
{| class="wikitable" style="text-align: center;"
+
{| class="wikitable" style="width: 100%;"
−
|-style="background:#eee"
+
|-style="background: #eee;"
−
! Name
+
!style="width: 128px;" | Name
−
! Documented
+
! Description
−
! Parameters understood
+
!style="width: 72px;" | Documented
−
! Response understood
+
!style="width: 72px;" | Parameters understood
 +
!style="width: 72px;" | Response understood
 +
|-
 +
! [[Web_APIs#AddBuddy|AddBuddy]]
 +
| Adds a player to the friends list.
 +
| {{Yes}}
 +
| {{Yes}}
 +
| {{Partially}}
 
|-
 
|-
 
! [[Web_APIs#CheckLogin|CheckLogin]]
 
! [[Web_APIs#CheckLogin|CheckLogin]]
−
| {{yes}}
+
| Checks if login is already used for account creation.
−
| {{yes}}
+
| {{Yes}}
−
| {{yes}}
+
| {{Yes}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#Connect|Connect]]
 +
| Opens connection.
 +
| {{No}}
 +
| {{No}}
 +
| {{No}}
 
|-
 
|-
 
! [[Web_APIs#Disconnect|Disconnect]]
 
! [[Web_APIs#Disconnect|Disconnect]]
−
| {{yes}}
+
| Closes connection.
−
| {{yes}}
+
| {{Yes}}
−
| {{yes}}
+
| {{Yes}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#GeneralCaps|GeneralCaps]]
 +
| Sends information about hardware to the server.
 +
| {{No}}
 +
| {{No}}
 +
| {{No}}
 +
|-
 +
! [[Web_APIs#GetBuddies|GetBuddies]]
 +
| Gets the friends list.
 +
| {{Partially}}
 +
| {{Yes}}
 +
| {{Partially}}
 
|-
 
|-
 
! [[Web_APIs#GetConnectionAndGameParams|GetConnectionAndGameParams]]
 
! [[Web_APIs#GetConnectionAndGameParams|GetConnectionAndGameParams]]
 +
| Gets a lot of information.
 +
| {{Partially}}
 +
| {{Yes}}
 +
| {{No}}
 +
|-
 +
! [[Web_APIs#GetLadderScores|GetLadderScores]]
 +
| ?
 +
| {{No}}
 +
| {{No}}
 +
| {{No}}
 +
|-
 +
! [[Web_APIs#GetLeagues|GetLeagues]]
 +
| Gets the regions list.
 +
| {{Yes}}
 +
| {{Yes}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#GetManialinkInfos|GetManialinkInfos]]
 +
| Gets info about a manialink.
 +
| {{Yes}}
 +
| {{Yes}}
 
| {{Partially}}
 
| {{Partially}}
 +
|-
 +
! [[Web_APIs#GetManialinkResource|GetManialinkResource]]
 +
| Gets info about a maniacode.
 
| {{Yes}}
 
| {{Yes}}
 +
| {{Yes}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#GetOnlineProfile|GetOnlineProfile]]
 +
| Gets info about the player.
 +
| {{Partially}}
 +
| {{No}}
 +
| {{Partially}}
 +
|-
 +
! [[Web_APIs#GetRankingsNew|GetRankingsNew]]
 +
| ?
 +
| {{No}}
 +
| {{No}}
 +
| {{No}}
 +
|-
 +
! [[Web_APIs#GfxPerf|GfxPerf]]
 +
| Sends performance information to the server.
 +
| {{No}}
 +
| {{No}}
 +
| {{No}}
 +
|-
 +
! [[Web_APIs#LiveUpdate|LiveUpdate]]
 +
| Tells the server we're playing online.
 +
| {{No}}
 +
| {{No}}
 
| {{No}}
 
| {{No}}
 
|-
 
|-
 
! [[Web_APIs#MailAccount|MailAccount]]
 
! [[Web_APIs#MailAccount|MailAccount]]
 +
| Requests the server to send a password recovery email.
 +
| {{Yes}}
 +
| {{Yes}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#OpenSession|OpenSession]]
 +
| Gets a session ID.
 +
| {{Partially}}
 
| {{Yes}}
 
| {{Yes}}
 +
| {{Partially}}
 +
|-
 +
! [[Web_APIs#ReceiveMessages|ReceiveMessages]]
 +
| Checks for messages.
 
| {{Yes}}
 
| {{Yes}}
 +
| {{Yes}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#RemoveBuddy|RemoveBuddy]]
 +
| Removes a player from the friends list.
 +
| {{Yes}}
 +
| {{Yes}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#RequestAllowed|RequestAllowed]]
 +
| Checks if a request is allowed.
 +
| {{Yes}}
 +
| {{Partially}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#SearchNew|SearchNew]]
 +
| Searches for servers (All/Recommended/Favorites).
 +
| {{No}}
 +
| {{No}}
 +
| {{No}}
 +
|-
 +
! [[Web_APIs#SendMessages|SendMessages]]
 +
| Sends a message to a player.
 +
| {{Yes}}
 +
| {{No}}
 +
| {{Yes}}
 +
|-
 +
! [[Web_APIs#Subscribe|Subscribe]]
 +
| Registers a new account. Goes over HTTPS (sometimes).
 +
| {{Partially}}
 +
| {{Partially}}
 
| {{Yes}}
 
| {{Yes}}
 
|}
 
|}

Latest revision as of 13:11, 27 May 2019

This page is to keep trace of what has already been documented. The table below lists all known remote calls.

Name Description Documented Parameters understood Response understood
AddBuddy Adds a player to the friends list. Yes Yes Partially
CheckLogin Checks if login is already used for account creation. Yes Yes Yes
Connect Opens connection. No No No
Disconnect Closes connection. Yes Yes Yes
GeneralCaps Sends information about hardware to the server. No No No
GetBuddies Gets the friends list. Partially Yes Partially
GetConnectionAndGameParams Gets a lot of information. Partially Yes No
GetLadderScores ? No No No
GetLeagues Gets the regions list. Yes Yes Yes
GetManialinkInfos Gets info about a manialink. Yes Yes Partially
GetManialinkResource Gets info about a maniacode. Yes Yes Yes
GetOnlineProfile Gets info about the player. Partially No Partially
GetRankingsNew ? No No No
GfxPerf Sends performance information to the server. No No No
LiveUpdate Tells the server we're playing online. No No No
MailAccount Requests the server to send a password recovery email. Yes Yes Yes
OpenSession Gets a session ID. Partially Yes Partially
ReceiveMessages Checks for messages. Yes Yes Yes
RemoveBuddy Removes a player from the friends list. Yes Yes Yes
RequestAllowed Checks if a request is allowed. Yes Partially Yes
SearchNew Searches for servers (All/Recommended/Favorites). No No No
SendMessages Sends a message to a player. Yes No Yes
Subscribe Registers a new account. Goes over HTTPS (sometimes). Partially Partially Yes
Retrieved from "https://wiki.xaseco.org/w/index.php?title=Web_API/Progress&oldid=359"