Difference between revisions of "Web API/Progress"

From Mania Tech Wiki
Jump to navigation Jump to search
m (OpenSession)
(fix alphabetic order)
 
(10 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
{| class="wikitable" style="width: 100%;"
 
{| class="wikitable" style="width: 100%;"
−
|-style="background:#eee"
+
|-style="background: #eee;"
−
!style="width: 128px" | Name
+
!style="width: 128px;" | Name
 
! Description
 
! Description
−
!style="width: 72px" | Documented
+
!style="width: 72px;" | Documented
−
!style="width: 72px" | Parameters understood
+
!style="width: 72px;" | Parameters understood
−
!style="width: 72px" | Response 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]]
−
| Used to check if login is already used for account creation.
+
| Checks if login is already used for account creation.
−
| {{yes}}
+
| {{Yes}}
−
| {{yes}}
+
| {{Yes}}
−
| {{yes}}
+
| {{Yes}}
 
|-
 
|-
 
! [[Web_APIs#Connect|Connect]]
 
! [[Web_APIs#Connect|Connect]]
−
| Used to login.
+
| Opens connection.
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
Line 22: Line 28:
 
|-
 
|-
 
! [[Web_APIs#Disconnect|Disconnect]]
 
! [[Web_APIs#Disconnect|Disconnect]]
−
| Used to disconnect (Duh).
+
| Closes connection.
−
| {{yes}}
+
| {{Yes}}
−
| {{yes}}
+
| {{Yes}}
−
| {{yes}}
+
| {{Yes}}
 
|-
 
|-
−
! [[Web_APIs#GetBuddies|GetBuddies]]
+
! [[Web_APIs#GeneralCaps|GeneralCaps]]
−
| Used to get friends list.
+
| Sends information about hardware to the server.
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
 +
|-
 +
! [[Web_APIs#GetBuddies|GetBuddies]]
 +
| Gets the friends list.
 +
| {{Partially}}
 +
| {{Yes}}
 +
| {{Partially}}
 
|-
 
|-
 
! [[Web_APIs#GetConnectionAndGameParams|GetConnectionAndGameParams]]
 
! [[Web_APIs#GetConnectionAndGameParams|GetConnectionAndGameParams]]
−
| Used to get a lot of informations.
+
| Gets a lot of information.
 
| {{Partially}}
 
| {{Partially}}
 
| {{Yes}}
 
| {{Yes}}
 +
| {{No}}
 +
|-
 +
! [[Web_APIs#GetLadderScores|GetLadderScores]]
 +
| ?
 +
| {{No}}
 +
| {{No}}
 
| {{No}}
 
| {{No}}
 
|-
 
|-
 
! [[Web_APIs#GetLeagues|GetLeagues]]
 
! [[Web_APIs#GetLeagues|GetLeagues]]
−
| Used to get regions list.
+
| Gets the regions list.
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
 
|-
 
|-
−
! [[Web_APIs#GeneralCaps|GeneralCaps]]
+
! [[Web_APIs#GetManialinkInfos|GetManialinkInfos]]
−
| Used to send informations about hardware to the server.
+
| Gets info about a manialink.
−
| {{No}}
+
| {{Yes}}
−
| {{No}}
+
| {{Yes}}
−
| {{No}}
+
| {{Partially}}
 
|-
 
|-
−
! [[Web_APIs#GetLadderScores|GetLadderScores]]
+
! [[Web_APIs#GetManialinkResource|GetManialinkResource]]
−
| ?
+
| Gets info about a maniacode.
−
| {{No}}
+
| {{Yes}}
−
| {{No}}
+
| {{Yes}}
−
| {{No}}
+
| {{Yes}}
 
|-
 
|-
 
! [[Web_APIs#GetOnlineProfile|GetOnlineProfile]]
 
! [[Web_APIs#GetOnlineProfile|GetOnlineProfile]]
−
| ?
+
| Gets info about the player.
−
| {{No}}
+
| {{Partially}}
−
| {{No}}
 
 
| {{No}}
 
| {{No}}
 +
| {{Partially}}
 
|-
 
|-
 
! [[Web_APIs#GetRankingsNew|GetRankingsNew]]
 
! [[Web_APIs#GetRankingsNew|GetRankingsNew]]
Line 70: Line 88:
 
|-
 
|-
 
! [[Web_APIs#GfxPerf|GfxPerf]]
 
! [[Web_APIs#GfxPerf|GfxPerf]]
−
| Used to send performance information to the server.
+
| Sends performance information to the server.
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
Line 76: Line 94:
 
|-
 
|-
 
! [[Web_APIs#LiveUpdate|LiveUpdate]]
 
! [[Web_APIs#LiveUpdate|LiveUpdate]]
−
| Used to tell the server we're playing online.
+
| Tells the server we're playing online.
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
Line 82: Line 100:
 
|-
 
|-
 
! [[Web_APIs#MailAccount|MailAccount]]
 
! [[Web_APIs#MailAccount|MailAccount]]
−
| Used to make the server send a password recovery email.
+
| Requests the server to send a password recovery email.
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
Line 88: Line 106:
 
|-
 
|-
 
! [[Web_APIs#OpenSession|OpenSession]]
 
! [[Web_APIs#OpenSession|OpenSession]]
−
| Used to get a session id.
+
| Gets a session ID.
 
| {{Partially}}
 
| {{Partially}}
−
| {{No}}
+
| {{Yes}}
 
| {{Partially}}
 
| {{Partially}}
 
|-
 
|-
 
! [[Web_APIs#ReceiveMessages|ReceiveMessages]]
 
! [[Web_APIs#ReceiveMessages|ReceiveMessages]]
−
| Used to get new messages.
+
| Checks for messages.
 +
| {{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}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
|-
 
|-
−
! [[Web_APIs#ReceiveMessages|SearchNew]]
+
! [[Web_APIs#SendMessages|SendMessages]]
−
| Used to search for servers (All/Recomended/Favorites)
+
| Sends a message to a player.
−
| {{No}}
+
| {{Yes}}
−
| {{No}}
 
 
| {{No}}
 
| {{No}}
 +
| {{Yes}}
 
|-
 
|-
 
! [[Web_APIs#Subscribe|Subscribe]]
 
! [[Web_APIs#Subscribe|Subscribe]]
−
| Used to register a new account. Goes over HTTPS (sometimes).
+
| Registers a new account. Goes over HTTPS (sometimes).
−
| {{No}}
+
| {{Partially}}
−
| {{No}}
+
| {{Partially}}
−
| {{No}}
+
| {{Yes}}
 
|}
 
|}

Latest revision as of 12: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"