Difference between revisions of "Web API/Progress"

From Mania Tech Wiki
Jump to navigation Jump to search
(spelling fixes, minor fmtg)
("used to" phrase not meaningful - if you don't use the call, nothing happens anyway ;))
Line 10: Line 10:
 
|-
 
|-
 
! [[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}}
Line 16: Line 16:
 
|-
 
|-
 
! [[Web_APIs#Connect|Connect]]
 
! [[Web_APIs#Connect|Connect]]
−
| Used to login.
+
| Opens connection.
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
Line 22: Line 22:
 
|-
 
|-
 
! [[Web_APIs#Disconnect|Disconnect]]
 
! [[Web_APIs#Disconnect|Disconnect]]
−
| Used to disconnect (Duh).
+
| Closes connection.
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
Line 28: Line 28:
 
|-
 
|-
 
! [[Web_APIs#GetBuddies|GetBuddies]]
 
! [[Web_APIs#GetBuddies|GetBuddies]]
−
| Used to get friends list.
+
| Gets the friends list.
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
Line 34: Line 34:
 
|-
 
|-
 
! [[Web_APIs#GetConnectionAndGameParams|GetConnectionAndGameParams]]
 
! [[Web_APIs#GetConnectionAndGameParams|GetConnectionAndGameParams]]
−
| Used to get a lot of information.
+
| Gets a lot of information.
 
| {{Partially}}
 
| {{Partially}}
 
| {{Yes}}
 
| {{Yes}}
Line 40: Line 40:
 
|-
 
|-
 
! [[Web_APIs#GetLeagues|GetLeagues]]
 
! [[Web_APIs#GetLeagues|GetLeagues]]
−
| Used to get regions list.
+
| Gets the regions list.
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
 
| {{Yes}}
Line 46: Line 46:
 
|-
 
|-
 
! [[Web_APIs#GeneralCaps|GeneralCaps]]
 
! [[Web_APIs#GeneralCaps|GeneralCaps]]
−
| Used to send information about hardware to the server.
+
| Sends information about hardware to the server.
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
Line 70: Line 70:
 
|-
 
|-
 
! [[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 76:
 
|-
 
|-
 
! [[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 82:
 
|-
 
|-
 
! [[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 88:
 
|-
 
|-
 
! [[Web_APIs#OpenSession|OpenSession]]
 
! [[Web_APIs#OpenSession|OpenSession]]
−
| Used to get a session id.
+
| Gets a session ID.
 
| {{Partially}}
 
| {{Partially}}
 
| {{Yes}}
 
| {{Yes}}
Line 94: Line 94:
 
|-
 
|-
 
! [[Web_APIs#ReceiveMessages|ReceiveMessages]]
 
! [[Web_APIs#ReceiveMessages|ReceiveMessages]]
−
| Used to get new messages.
+
| Gets new messages.
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
Line 100: Line 100:
 
|-
 
|-
 
! [[Web_APIs#ReceiveMessages|SearchNew]]
 
! [[Web_APIs#ReceiveMessages|SearchNew]]
−
| Used to search for servers (All/Recommended/Favorites).
+
| Searches for servers (All/Recommended/Favorites).
 
| {{No}}
 
| {{No}}
 
| {{No}}
 
| {{No}}
Line 106: Line 106:
 
|-
 
|-
 
! [[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).
 
| {{Partially}}
 
| {{Partially}}
 
| {{Partially}}
 
| {{Partially}}
 
| {{Yes}}
 
| {{Yes}}
 
|}
 
|}

Revision as of 17:55, 13 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
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
GetBuddies Gets the friends list. No No No
GetConnectionAndGameParams Gets a lot of information. Partially Yes No
GetLeagues Gets the regions list. Yes Yes Yes
GeneralCaps Sends information about hardware to the server. No No No
GetLadderScores ? No No No
GetOnlineProfile ? No No No
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 Gets new messages. No No No
SearchNew Searches for servers (All/Recommended/Favorites). No No No
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=339"