Break out proto pages
This commit is contained in:
parent
a5e2a7569b
commit
c8e7fc5d86
24
__base.html
Normal file
24
__base.html
Normal file
@ -0,0 +1,24 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href=".">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
</body>
|
33
proto/apsmanager.html
Normal file
33
proto/apsmanager.html
Normal file
@ -0,0 +1,33 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>apsmanager</code></h1>
|
||||
<h2 id="getstat"><code>apsmanager.getstat</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<apsmanager method="getstat" model*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<apsmanager status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
</body>
|
232
proto/cardmng.html
Normal file
232
proto/cardmng.html
Normal file
@ -0,0 +1,232 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>cardmng</code></h1>
|
||||
<p>As the name might imply, this service is responsible for handling interactions with physical e-Amusement cards.
|
||||
e-Amusement currently has two different types of cards in circulation. There are classic e-Amusement cards
|
||||
making use of a magnetic stripe, and the newer RFID cards using FeliCa (these are probably what you have). They
|
||||
are identified in requests using the <code>cardtype</code> attribute as in the below table.
|
||||
</p>
|
||||
<p>e-Amusement cards have a "card number" and a "card id". Confusingly, neither is a number. The card number is the
|
||||
one printed on your card. The card ID is your KONAMI ID. The number is derrived from your ID using an algorithm
|
||||
that I'll detail here once I get round to it.</p>
|
||||
<p>In the interest of not wasting space, <code>cardid</code> and <code>cardtype</code> will be omitted from
|
||||
individual breakdowns where their meaning is obvious.</p>
|
||||
|
||||
<h4>Card types:</h4>
|
||||
<table class="nocode">
|
||||
<thead>
|
||||
<tr>
|
||||
<td><code>cardtype</code></td>
|
||||
<td>Meaning</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<td><code>1</code></td>
|
||||
<td>Old style magnetic stripe card</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>2</code></td>
|
||||
<td>FeliCa RFID card</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<ul>
|
||||
<li><code><a href="#inquire">cardmng.inquire</a></code></li>
|
||||
<li><code><a href="#getrefid">cardmng.getrefid</a></code></li>
|
||||
<li><code><a href="#bindmodel">cardmng.bindmodel</a></code></li>
|
||||
<li><code><a href="#bindcard">cardmng.bindcard</a></code></li>
|
||||
<li><code><a href="#authpass">cardmng.authpass</a></code></li>
|
||||
<li><code><a href="#getkeepspan">cardmng.getkeepspan</a></code></li>
|
||||
<li><code><a href="#getkeepremain">cardmng.getkeepremain</a></code></li>
|
||||
<li><code><a href="#getdatalist">cardmng.getdatalist</a></code></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2 id="inquire"><code>cardmng.inquire</code></h2>
|
||||
<p>Request information about a card that has been inserted or touched against a reader.</p>
|
||||
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<cardmng method="inquire" cardid="" cardtype="" update="" model*="" />
|
||||
</call></code></pre>
|
||||
<table class="nocode">
|
||||
<tr>
|
||||
<td><code>update</code></td>
|
||||
<td>Should the tracked last play time be updated by this inquiry? (Just a guess)</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<cardmng status="<i>status</i>" refid="" dataid="" pcode="" newflag="" binded="" expired=" ecflag="" useridflag="" extidflag="" lastupdate="" />
|
||||
</response></code></pre>
|
||||
<p>To handle this request, we first must lookup if this <code>cardid</code> has ever been seen by our servers
|
||||
before. If not, we abort with a <code>112</code> status. Otherwise, we proceeed to check if this card has been
|
||||
seen for this specific game. If we have never seen this card used on this game, it is possible this card was
|
||||
used with an older version of this game, and migration is supported, in which case we report as if we had found
|
||||
a profile for this game.</p>
|
||||
<table class="nocode">
|
||||
<tr>
|
||||
<td><code>refid</code></td>
|
||||
<td>A reference to this card to be used in other requests</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>dataid</code></td>
|
||||
<td>Appears to be set the same as <code>refid</code>; presumably to allow different keys for game state vs
|
||||
login details.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>newflag</code></td>
|
||||
<td>Inverse of <code>binded</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>binded</code></td>
|
||||
<td>Has a profile ever been created for this game (or an older version, requiring a migration)
|
||||
(<code>1</code> or <code>0</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>expired</code></td>
|
||||
<td>? Just set to <code>0</code>.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2 id="getrefid"><code>cardmng.getrefid</code></h2>
|
||||
<p>Register a new card to this server.</p>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<cardmng method="getrefid" cardtype="" cardid=" newflag="" passwd="" model*="" />
|
||||
</call></code></pre>
|
||||
<table class="nocode">
|
||||
<tr>
|
||||
<td><code>newflag</code></td>
|
||||
<td>?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>passwd</code></td>
|
||||
<td>The pin for this new user. <i>Should</i> always be a four digit number (and that's worth validating),
|
||||
but it's passed as a string so could feasibly be anything desired.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<cardmng status="<i>status</i>" refid="" dataid="" pcode="" />
|
||||
</response></code></pre>
|
||||
<table class="nocode">
|
||||
<tr>
|
||||
<td><code>refid</code></td>
|
||||
<td>A reference to this card to be used in other requests</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>dataid</code></td>
|
||||
<td>Appears to be set the same as <code>refid</code>; presumably to allow different keys for game state vs
|
||||
login details.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>pcode</code></td>
|
||||
<td>? Not present in captured data.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2 id="bindmodel"><code>cardmng.bindmodel</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<cardmng method="bindmodel" refid="" newflag="" model*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<cardmng status="<i>status</i>" dataid="" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="bindcard"><code>cardmng.bindcard</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<cardmng method="bindcard" cardtype="" newid="" refid="" model*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<cardmng status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="authpass"><code>cardmng.authpass</code></h2>
|
||||
<p>Test a pin for a card. This request notably uses the <code>refid</code>, so required a
|
||||
<code>cardmng.inquire</code> call to be made first.
|
||||
</p>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<cardmng method="authpass" refid="" pass="" model*="" />
|
||||
</call></code></pre>
|
||||
<table class="nocode">
|
||||
<tr>
|
||||
<td><code>refid</code></td>
|
||||
<td>The reference we received either during <code>cardmng.inquire</code> or <code>cardmng.getrefid</code>
|
||||
(the latter for new cards)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>pass</code></td>
|
||||
<td>The pin to test. See <code>cardmng.getrefid</code>.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<cardmng status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
<p>If the pin is valid, status should be <code>0</code>. Otherwise, <code>116</code>.</p>
|
||||
|
||||
<h2 id="getkeepspan"><code>cardmng.getkeepspan</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<cardmng method="getkeepspan" model*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<cardmng status="<i>status</i>" keepspan="" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="getkeepremain"><code>cardmng.getkeepremain</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<cardmng method="getkeepremain" refid="" model*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<cardmng status="<i>status</i>" keepremain="" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="getdatalist"><code>cardmng.getdatalist</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<cardmng method="getdatalist" refid="" model*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<cardmng status="<i>status</i>">
|
||||
<item[]>
|
||||
<mcode __type="str" />
|
||||
<dataid __type="str" />
|
||||
<regtime __type="str" />
|
||||
<lasttime __type="str" />
|
||||
<exptime __type="str" />
|
||||
<expflag __type="u8" />
|
||||
</item[]>
|
||||
</cardmng>
|
||||
</response></code></pre>
|
||||
</body>
|
54
proto/dlstatus.html
Normal file
54
proto/dlstatus.html
Normal file
@ -0,0 +1,54 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>dlstatus</code></h1>
|
||||
<h2 id="done"><code>dlstatus.done</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<dlstatus method="done">
|
||||
<url>
|
||||
<param __type="str" />
|
||||
</url>
|
||||
<name __type="str" />
|
||||
<size __type="s32" />
|
||||
</dlstatus>
|
||||
</call></code></pre>
|
||||
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<dlstatus status="<i>status</i>">
|
||||
<progress __type="s32" />
|
||||
</dlstatus>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="progress"><code>dlstatus.progress</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<dlstatus method="progress" />
|
||||
<progress __type="s32" />
|
||||
</dlstatus>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<dlstatus status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
</body>
|
200
proto/eacoin.html
Normal file
200
proto/eacoin.html
Normal file
@ -0,0 +1,200 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>eacoin</code></h1>
|
||||
<h2 id="checkin"><code>eacoin.checkin</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="checkin">
|
||||
<cardtype __type="str" />
|
||||
<cardid __type="str" />
|
||||
<passwd __type="str" />
|
||||
<ectype __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>">
|
||||
<sequence __type="s16" />
|
||||
<acstatus __type="u8" />
|
||||
<acid __type="str" />
|
||||
<acname __type="str" />
|
||||
<balance __type="s32" />
|
||||
<sessid __type="str" />
|
||||
</eacoin>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="checkout"><code>eacoin.checkout</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="checkout">
|
||||
<sessid __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="consume"><code>eacoin.consume</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="consume" esid="">
|
||||
<sessid __type="str" />
|
||||
<sequence __type="s16" />
|
||||
<payment __type="s32" />
|
||||
<service __type="s16" />
|
||||
<itemtype __type="str" />
|
||||
<detail __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>">
|
||||
<acstatus __type="u8" />
|
||||
<autocharge __type="u8" />
|
||||
<balance __type="s32" />
|
||||
</eacoin>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="getbalance"><code>eacoin.getbalance</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="getbalance">
|
||||
<sessid __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>">
|
||||
<acstatus __type="u8" />
|
||||
<balance __type="s32" />
|
||||
</eacoin>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="getecstatus"><code>eacoin.getecstatus</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="getecstatus" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>">
|
||||
<ectype __type="str" />
|
||||
<ecstatus __type="u8" />
|
||||
</eacoin>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="touch"><code>eacoin.touch</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="touch">
|
||||
<sessid __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="opchpass"><code>eacoin.opchpass</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="opchpass">
|
||||
<passwd __type="str" />
|
||||
<newpasswd __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="opcheckin"><code>eacoin.opcheckin</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="opcheckin">
|
||||
<passwd __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>">
|
||||
<sessid __type="str" />
|
||||
</eacoin>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="opcheckout"><code>eacoin.opcheckout</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="opcheckout">
|
||||
<sessid __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="getlog"><code>eacoin.getlog</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eacoin method="getlog">
|
||||
<sessid __type="str" />
|
||||
<logtype __type="str" />
|
||||
<ectype __type="str" />
|
||||
<target __type="str" />
|
||||
<perpage __type="s16" />
|
||||
<page __type="s16" />
|
||||
<sesstype __type="str" />
|
||||
</eacoin>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eacoin status="<i>status</i>">
|
||||
<processing __type="u8" />
|
||||
<topic>
|
||||
<sumdate __type="str" />
|
||||
<sumfrom __type="str" />
|
||||
<sumto __type="str" />
|
||||
|
||||
<today __type="s32" />
|
||||
<average __type="s32" />
|
||||
<total __type="s32" />
|
||||
</topic>
|
||||
<summary>
|
||||
<items __type="s32" />
|
||||
</summary>
|
||||
<history>
|
||||
<item[]>
|
||||
<date __type="str" />
|
||||
<consume __type="s32" />
|
||||
<service __type="s32" />
|
||||
<cardtype __type="str" />
|
||||
<cardno __type="str" />
|
||||
<title __type="str" />
|
||||
<systemid __type="str" />
|
||||
</item[]>
|
||||
</history>
|
||||
</eacoin>
|
||||
</response></code></pre>
|
||||
</body>
|
37
proto/esign.html
Normal file
37
proto/esign.html
Normal file
@ -0,0 +1,37 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>esign</code></h1>
|
||||
<h2 id="request"><code>esign.request</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<esign method="request">
|
||||
<i>placeholder</i>
|
||||
</esign>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<esign status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</esign>
|
||||
</response></code></pre>
|
||||
</body>
|
50
proto/esoc.html
Normal file
50
proto/esoc.html
Normal file
@ -0,0 +1,50 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>esoc</code></h1>
|
||||
<h2 id="read"><code>esoc.read</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<esoc method="read">
|
||||
<senddata />
|
||||
</esoc>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<esoc status="<i>status</i>">
|
||||
<recvdata />
|
||||
</esoc>
|
||||
</response></code></pre>
|
||||
<p>Go figure.</p>
|
||||
|
||||
<h2 id="write"><code>esoc.write</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<esoc method="write">
|
||||
<senddata />
|
||||
</esoc>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<esoc status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
</body>
|
58
proto/eventlog.html
Normal file
58
proto/eventlog.html
Normal file
@ -0,0 +1,58 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>eventlog</code></h1>
|
||||
<h2 id="write"><code>eventlog.write</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<eventlog method="write">
|
||||
<retrycnt __type="u32" />
|
||||
<data>
|
||||
<eventid __type="str" />
|
||||
<eventorder __type="s32" />
|
||||
<pcbtime __type="u64" />
|
||||
<gamesession __type="s64" />
|
||||
<strdata1 __type="str" />
|
||||
<strdata2 __type="str" />
|
||||
<numdata1 __type="s64" />
|
||||
<numdata2 __type="s64" />
|
||||
<locationid __type="str" />
|
||||
</data>
|
||||
</eventlog>
|
||||
</call></code></pre>
|
||||
<p>Event ID list:</p>
|
||||
<ul>
|
||||
<li><code>G_GAMED</code></li>
|
||||
<li><code>S_ERROR</code></li>
|
||||
<li><code>S_PWRON</code> <b>TODO: find more!</b></li>
|
||||
<li><code>T_OTDEMO</code></li>
|
||||
</ul>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<eventlog status="<i>status</i>">
|
||||
<gamesession __type="s64" />
|
||||
<logsendflg __type="s32" />
|
||||
<logerrlevel __type="s32" />
|
||||
<evtidnosendflg __type="s32" />
|
||||
</eventlog>
|
||||
</response></code></pre>
|
||||
</body>
|
140
proto/facility.html
Normal file
140
proto/facility.html
Normal file
@ -0,0 +1,140 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>facility</code></h1>
|
||||
<h2 id="get"><code>facility.get</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<facility method="get" privateip*="" encoding*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<facility expire=""\ status="<i>status</i>">
|
||||
<calendar*>
|
||||
<year __type="s16" />
|
||||
<holiday __type="s16" />
|
||||
</calendar>
|
||||
<location>
|
||||
<id __type="str" />
|
||||
<country __type="str" />
|
||||
<region __type="str" />
|
||||
<name __type="str" />
|
||||
<type __type="u8" />
|
||||
<countryname __type="str" />
|
||||
<countryjname __type="str" />
|
||||
<regionname __type="str" />
|
||||
<regionjname __type="str" />
|
||||
<customercode __type="str" />
|
||||
<companycode __type="str" />
|
||||
<latitude __type="s32" />
|
||||
<longitude __type="s32" />
|
||||
<accuracy __type="u8" />
|
||||
</location>
|
||||
<line>
|
||||
<id __type="str" />
|
||||
<class __type="u8" />
|
||||
</line>
|
||||
<portfw>
|
||||
<globalip __type="ip4" />
|
||||
<globalport __type="s16" />
|
||||
<privateport __type="s16" />
|
||||
</portfw>
|
||||
<public>
|
||||
<flag __type="u8" />1</ flag>
|
||||
<name __type="str" />
|
||||
<latitude __type="str">0<latitude>
|
||||
<longitude __type="str">0<longitude>
|
||||
</public>
|
||||
<share>
|
||||
<eapass*>
|
||||
<valid __type="?" />
|
||||
</eapass>
|
||||
<eacoin>
|
||||
<notchamount __type="s32" />
|
||||
<notchcount __type="s32" />
|
||||
<supplylimit __type="s32">100000<supplylimit>
|
||||
</eacoin>
|
||||
<url>
|
||||
<eapass __type="str">www.ea-pass.konami.net<eapass>
|
||||
<arcadefan __type="str">www.konami.jp/am<arcadefan>
|
||||
<konaminetdx __type="str">http://am.573.jp<konaminetdx>
|
||||
<konamiid __type="str">http://id.konami.jp<konamiid>
|
||||
<eagate __type="str">http://eagate.573.jp<eagate>
|
||||
</url>
|
||||
</share>
|
||||
</facility>
|
||||
</response></code></pre>
|
||||
<p><i>I'm not totally sure what type <code>share/eapass/valid</code> is meant to be, but it's optional, so I'd
|
||||
suggest just not bothering and leaving it out :).</i></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<td>Country</td>
|
||||
<td>Code</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<td>Hong Kong</td>
|
||||
<td><code>HK</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Taiwan</td>
|
||||
<td><code>TW</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Korea</td>
|
||||
<td><code>KR</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>USA</td>
|
||||
<td><code>US</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Thailand</td>
|
||||
<td><code>TH</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Indonesia</td>
|
||||
<td><code>ID</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Singapore</td>
|
||||
<td><code>SG</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Phillipines</td>
|
||||
<td><code>PH</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Macao</td>
|
||||
<td><code>MO</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Japan</td>
|
||||
<td><code>JP</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
<p><code>globalip</code> (and associated ports) shold be the IP:port of the cabinet.</p>
|
||||
<p><code>region</code> is used for Japan, and has the value <code>JP-[prefecture]</code> where prefecture ranges
|
||||
from 1 through 47.</p>
|
||||
<p><b>TODO: Compile the list of regions</b></p>
|
||||
</body>
|
387
proto/game/sv4.html
Normal file
387
proto/game/sv4.html
Normal file
@ -0,0 +1,387 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="../..">Contents</a></td>
|
||||
<td><a href="../../transport.html">Transport layer</a></td>
|
||||
<td><a href="../../packet.html">Packet format</a></td>
|
||||
<td><a href="../../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1 id="game"><code>game</code></h1>
|
||||
<h2 id="sample"><code>game.sv4_sample</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_sample">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="new"><code>game.sv4_new</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_new">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="load"><code>game.sv4_load</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_load">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="load_m"><code>game.sv4_load_m</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_load_m">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="save"><code>game.sv4_save</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_save">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="save_m"><code>game.sv4_save_m</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_save_m">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="common"><code>game.sv4_common</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_common">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="shop"><code>game.sv4_shop</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_shop">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="hiscore"><code>game.sv4_hiscore</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_hiscore">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="buy"><code>game.sv4_buy</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_buy">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="exception"><code>game.sv4_exception</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_exception">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="entry_s"><code>game.sv4_entry_s</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_entry_s">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="entry_e"><code>game.sv4_entry_e</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_entry_e">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="frozen"><code>game.sv4_frozen</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_frozen">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="lounce"><code>game.sv4_lounce</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_lounce">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="save_e"><code>game.sv4_save_e</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_save_e">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="save_pb"><code>game.sv4_save_pb</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_save_pb">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="save_c"><code>game.sv4_save_c</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_save_c">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="play_s"><code>game.sv4_play_s</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_play_s">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="play_e"><code>game.sv4_play_e</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_play_e">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="serial"><code>game.sv4_serial</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_serial">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="save_fi"><code>game.sv4_save_fi</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_save_fi">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="print"><code>game.sv4_print</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_print">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="print_h"><code>game.sv4_print_h</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_print_h">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="load_r"><code>game.sv4_load_r</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_load_r">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="save_campaign"><code>game.sv4_save_campaign</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<game method="sv4_save_campaign">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<game status="<i>status</i>">
|
||||
<i>placeholder</i>
|
||||
</game>
|
||||
</response></code></pre>
|
||||
</body>
|
103
proto/matching.html
Normal file
103
proto/matching.html
Normal file
@ -0,0 +1,103 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>matching</code></h1>
|
||||
<h2 id="request"><code>matching.request</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<matching method="request">
|
||||
<info>
|
||||
<version __type="s32" />
|
||||
</info>
|
||||
<data>
|
||||
<matchtyp __type="s32" />
|
||||
<matchgrp __type="s32" />
|
||||
<matchflg __type="s32" />
|
||||
<waituser __type="s32" />
|
||||
<waittime __type="s32" />
|
||||
<joinip __type="str" />
|
||||
<localip __type="str" />
|
||||
<localport __type="s32" />
|
||||
<dataid __type="str" />
|
||||
<gamekind __type="str" />
|
||||
<locationid __type="str" />
|
||||
<lineid __type="str" />
|
||||
<locationcountry __type="str" />
|
||||
<locationregion __type="str" />
|
||||
</data>
|
||||
</matching>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<matching status="<i>status</i>">
|
||||
<hostid __type="s64" />
|
||||
<result __type="s32" />
|
||||
<hostip_g __type="str" />
|
||||
<hostip_l __type="str" />
|
||||
<hostport_l __type="s32" />
|
||||
<hostport_g __type="s32" />
|
||||
</matching>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="wait"><code>matching.wait</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<matching method="wait">
|
||||
<info>
|
||||
<version __type="s32" />
|
||||
</info>
|
||||
<data>
|
||||
<hostid __type="s64" />
|
||||
<locationid __type="str" />
|
||||
<lineid __type="str" />
|
||||
</data>
|
||||
</matching>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<matching status="<i>status</i>">
|
||||
<result __type="s32" />
|
||||
<prwtime __type="s32" />
|
||||
</matching>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="finish"><code>matching.finish</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<matching method="finish">
|
||||
<info>
|
||||
<version __type="s32" />
|
||||
</info>
|
||||
<data>
|
||||
<hostid __type="s64" />
|
||||
<locationid __type="str" />
|
||||
<lineid __type="str" />
|
||||
</data>
|
||||
</matching>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<matching status="<i>status</i>">
|
||||
<result __type="s32" />
|
||||
</matching>
|
||||
</response></code></pre>
|
||||
</body>
|
35
proto/message.html
Normal file
35
proto/message.html
Normal file
@ -0,0 +1,35 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>message</code></h1>
|
||||
<h2 id="get"><code>message.get</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<message method="get" model*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<message expire="" status="<i>status</i>">
|
||||
<item[] name="" start="" end="" data="" />
|
||||
</message>
|
||||
</response></code></pre>
|
||||
</body>
|
47
proto/package.html
Normal file
47
proto/package.html
Normal file
@ -0,0 +1,47 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>package</code></h1>
|
||||
<h2 id="list"><code>package.list</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<package method="list" pkgtype="<i>pkgtype</i>" model*="" />
|
||||
</call></code></pre>
|
||||
<p><code>all</code> is the only currently observed value for <code>pkgtype</code></p>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<package status="<i>status</i>">
|
||||
<item[] url="" />
|
||||
</package>
|
||||
</response></code></pre>
|
||||
<p>A list of all packages available for download.</p>
|
||||
|
||||
<h2 id="intend"><code>package.intend</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<package method="intend" url="" model*="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<package status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
</body>
|
41
proto/pcbevent.html
Normal file
41
proto/pcbevent.html
Normal file
@ -0,0 +1,41 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>pcbevent</code></h1>
|
||||
<h2 id="put"><code>pcbevent.put</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<pcbevent method="put">
|
||||
<time __type="time" />
|
||||
<seq __type="u32" />
|
||||
<item[]>
|
||||
<name __type="str" />
|
||||
<value __type="s32" />
|
||||
<time __type="time" />
|
||||
</item[]>
|
||||
</pcbevent>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<pcbevent status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
</body>
|
39
proto/pcbtracker.html
Normal file
39
proto/pcbtracker.html
Normal file
@ -0,0 +1,39 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>pcbtracker</code></h1>
|
||||
<h2 id="alive"><code>pcbtracker.alive</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<pcbtracker method="alive" model*="" hardid="" softid="" accountid="" agree="" ecflag="" />
|
||||
</call></code></pre>
|
||||
<p><code>ecflag</code> here is determining if the arcade operator allows the use of paseli on this machine.</p>
|
||||
<p><code>agree@</code> and <code>ecflag@</code> appear to either be totally non present, or present with a value of
|
||||
<code>"1"</code>, but then again I may be reading the code wrong, so take that with a pinch of salt.
|
||||
</p>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<pcbtracker status="" time="" limit="" ecenable="" eclimit="" >
|
||||
</response></code></pre>
|
||||
<p>As you might guess, <code>ecenable@</code> is therefore the flag to determine if paseli is enabled (i.e. the
|
||||
arcade operator and the server both allow its use).</p>
|
||||
</body>
|
156
proto/playerdata.html
Normal file
156
proto/playerdata.html
Normal file
@ -0,0 +1,156 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>playerdata</code></h1>
|
||||
<h2 id="usergamedata_send"><code>playerdata.usergamedata_send</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<playerdata method="usergamedata_send">
|
||||
<retrycnt __type="u32" />
|
||||
<info>
|
||||
<version __type="u32" />
|
||||
</info>
|
||||
<data>
|
||||
<refid __type="str" />
|
||||
<dataid __type="str" />
|
||||
<gamekind __type="str" />
|
||||
<datanum __type="u32" />
|
||||
<record>
|
||||
<d[] __type="str" />
|
||||
</record>
|
||||
</data>
|
||||
</playerdata>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<playerdata status="<i>status</i>">
|
||||
<result __type="s32" />
|
||||
</playerdata>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="usergamedata_recv"><code>playerdata.usergamedata_recv</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<playerdata method="usergamedata_recv">
|
||||
<info>
|
||||
<version __type="u32" />
|
||||
</info>
|
||||
<data>
|
||||
<refid __type="str">
|
||||
<dataid __type="str">
|
||||
<gamekind __type="str">
|
||||
<recv_num __type="u32">
|
||||
</data>
|
||||
</playerdata>
|
||||
</call></code></pre>
|
||||
<pre><code><call <i>...</i>>
|
||||
<playerdata method="usergamedata_recv">
|
||||
<data>
|
||||
<refid __type="str">
|
||||
<dataid __type="str">
|
||||
<gamekind __type="str">
|
||||
<recv_csv __type="str">
|
||||
</data>
|
||||
</playerdata>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<playerdata status="<i>status</i>">
|
||||
<player>
|
||||
<result>
|
||||
<record_num __type="u32" />
|
||||
</result>
|
||||
<record>
|
||||
<d[]>
|
||||
<bin1 __type="str" />
|
||||
</d[]>
|
||||
</record>
|
||||
</player>
|
||||
</playerdata>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="usergamedata_inheritance"><code>playerdata.usergamedata_inheritance</code></h2>
|
||||
<p>See: <code>playerdata.usergamedata_recv</code></p>
|
||||
|
||||
<h2 id="usergamedata_condrecv"><code>playerdata.usergamedata_condrecv</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<playerdata method="usergamedata_condrecv">
|
||||
<info>
|
||||
<version __type="s32" />
|
||||
</info>
|
||||
<data>
|
||||
<dataid __type="str" />
|
||||
<gamekind __type="str" />
|
||||
<vkey __type="str" />
|
||||
<conditionkey __type="str" />
|
||||
<columns_bit __type="u64" />
|
||||
<conditions_num __type="u32" />
|
||||
<where __type="str" />
|
||||
<order_num __type="u32" />
|
||||
<order __type="str" />
|
||||
<recv_num __type="u32" />
|
||||
</info>
|
||||
</playerdata>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<playerdata status="<i>status</i>">
|
||||
<player>
|
||||
<result __type="s32" />
|
||||
<record_num __type="s32" />
|
||||
<record>
|
||||
<d[]>
|
||||
<bin1 __type="str" />
|
||||
</d[]>
|
||||
<record/>
|
||||
</player>
|
||||
</playerdata>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="usergamedata_scorerank"><code>playerdata.usergamedata_scorerank</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<playerdata method="usergamedata_scorerank">
|
||||
<info>
|
||||
<version __type="s32" />
|
||||
</info>
|
||||
<data>
|
||||
<dataid __type="str" />
|
||||
<gamekind __type="str" />
|
||||
<ckey __type="str" />
|
||||
<conditionkey __type="str" />
|
||||
<score __type="str" />
|
||||
</data>
|
||||
</playerdata>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<playerdata status="<i>status</i>">
|
||||
<rank>
|
||||
<result __type="s32" />
|
||||
<rank __type="s32" />
|
||||
<updatetime __type="u64" />
|
||||
</rank>
|
||||
</playerdata>
|
||||
</response></code></pre>
|
||||
</body>
|
70
proto/services.html
Normal file
70
proto/services.html
Normal file
@ -0,0 +1,70 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>services</code></h1>
|
||||
<h2 id="get"><code>services.get</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<services method="get" model*="" >
|
||||
<info>
|
||||
<AVS2 __type="str"><i>AVS2 version</i></AVS2>
|
||||
</info>
|
||||
</services>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<services expire="" method="get" mode="" status="<i>status</i>">
|
||||
<item[] name="<i>service</i>" url="<i>url</i>" />
|
||||
</services>
|
||||
</response></code></pre>
|
||||
<p>Known services are:</p>
|
||||
<ul>
|
||||
<li><code>ntp</code></li>
|
||||
<li><code>keepalive</code></li>
|
||||
<li><code>cardmng</code></li>
|
||||
<li><code>facility</code></li>
|
||||
<li><code>message</code></li>
|
||||
<li><code>numbering</code></li>
|
||||
<li><code>package</code></li>
|
||||
<li><code>pcbevent</code></li>
|
||||
<li><code>pcbtracker</code></li>
|
||||
<li><code>pkglist</code></li>
|
||||
<li><code>posevent</code></li>
|
||||
<li><code>userdata</code></li>
|
||||
<li><code>userid</code></li>
|
||||
<li><code>eacoin</code></li>
|
||||
<li><code>local</code></li>
|
||||
<li><code>local2</code></li>
|
||||
<li><code>lobby</code></li>
|
||||
<li><code>lobby2</code></li>
|
||||
<li><code>dlstatus</code></li>
|
||||
<li><code>netlog</code></li>
|
||||
<li><code>sidmgr</code></li>
|
||||
<li><code>globby</code></li>
|
||||
</ul>
|
||||
<p>Most of these will usually just return the URL to the eAmuse server (or your fake one ;D). <code>ntp</code> is a
|
||||
notable exception, unless you're planning on reimplementing NTP. <code>keepalive</code> will likely alsop be a
|
||||
custom URL with query parameters pre-baked.</p>
|
||||
<p><code>mode</code> is one of <code>operation</code>, <code>debug</code>, <code>test</code>, or
|
||||
<code>factory</code>.
|
||||
</p>
|
||||
</body>
|
94
proto/sidmgr.html
Normal file
94
proto/sidmgr.html
Normal file
@ -0,0 +1,94 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>sidmgr</code></h1>
|
||||
<h2 id="create"><code>sidmgr.create</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<sidmgr method="create">
|
||||
<cardtype __type="str" />
|
||||
<cardid __type="str" />
|
||||
<cardgid __type="str" />
|
||||
<steal __type="u8" />
|
||||
</sidmgr>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<sidmgr status="<i>status</i>">
|
||||
<state __type="u32" />
|
||||
<e_count __type="u8" />
|
||||
<last __type="time" />
|
||||
<locked __type="time" />
|
||||
<sid __type="str" />
|
||||
<cardid_status __type="u8" />
|
||||
<refid __type="str" />
|
||||
</sidmgr>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="open"><code>sidmgr.open</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<sidmgr method="open" sid="" >
|
||||
<pass __type="str" />
|
||||
</sidmgr>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<sidmgr status="<i>status</i>">
|
||||
<state __type="u32" />
|
||||
<refid __type="str" />
|
||||
<locked __type="time" />
|
||||
</sidmgr>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="touch"><code>sidmgr.touch</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<sidmgr method="touch" sid="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<sidmgr status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="branch"><code>sidmgr.branch</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<sidmgr method="branch" sid="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<sidmgr status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="close"><code>sidmgr.close</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<sidmgr method="close" sid="" />
|
||||
<cause __type="u32" />
|
||||
</sidmgr>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<sidmgr status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
</body>
|
126
proto/system.html
Normal file
126
proto/system.html
Normal file
@ -0,0 +1,126 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>system</code></h1>
|
||||
<h2 id="getmaster"><code>system.getmaster</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<system method="getmaster">
|
||||
<data>
|
||||
<gamekind __type="str" />
|
||||
<datatype __type="str" />
|
||||
<datakey __type="str" />
|
||||
</data>
|
||||
</system>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<system status="<i>status</i>">
|
||||
<result __type="s32" />
|
||||
<strdata1 __type="str" />
|
||||
<strdata2 __type="str" />
|
||||
<updatedate __type="u64" />
|
||||
</system>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="getlocationiplist"><code>system.getlocationiplist</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<system method="getlocationiplist">
|
||||
<data>
|
||||
<locationid __type="str" />
|
||||
<lineid __type="str" />
|
||||
</data>
|
||||
</system>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<system status="<i>status</i>">
|
||||
<result __type="s32" />
|
||||
<iplist>
|
||||
<record_num __type="s32" />
|
||||
<record[]>
|
||||
<localconn __type="str" />
|
||||
</record[]>
|
||||
</iplist>
|
||||
</system>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="xrpcproxy"><code>system.xrpcproxy</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<system method="xrpcproxy">
|
||||
<info>
|
||||
<version __type="s32" />
|
||||
</info>
|
||||
<data>
|
||||
<hostid __type="s64" />
|
||||
<locationid __type="str" />
|
||||
<lineid __type="str" />
|
||||
</data>
|
||||
</system>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<system status="<i>status</i>">
|
||||
<result __type="s32" />
|
||||
<pwrtime __type="s32" />
|
||||
<matchlist>
|
||||
<record_num __type="u32" />
|
||||
<record[]>
|
||||
<pcbid __type="str" />
|
||||
<statusflg __type="str" />
|
||||
<matchgrp __type="s32" />
|
||||
<hostid __type="s64" />
|
||||
<jointime __type="u64" />
|
||||
<connip_g __type="str" />
|
||||
<connport_g __type="s32" />
|
||||
<connip_l __type="str" />
|
||||
<connport_l __type="s32" />
|
||||
</record[]>
|
||||
</matchlist>
|
||||
</system>
|
||||
</response></code></pre>
|
||||
|
||||
<h2 id="convcardnumber"><code>system.convcardnumber</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<system method="convcardnumber">
|
||||
<info>
|
||||
<version __type="s32" />
|
||||
</info>
|
||||
<data>
|
||||
<card_id __type="str" />
|
||||
<card_type __type="s32" />
|
||||
</data>
|
||||
</system>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<system status="<i>status</i>">
|
||||
<result __type="s32" />
|
||||
<data>
|
||||
<card_number __type="str" />
|
||||
</data>
|
||||
</system>
|
||||
</response></code></pre>
|
||||
</body>
|
40
proto/traceroute.html
Normal file
40
proto/traceroute.html
Normal file
@ -0,0 +1,40 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>traceroute</code></h1>
|
||||
<h2 id="send"><code>traceroute.send</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<traceroute proto="" method="send">
|
||||
<hop[]>
|
||||
<valid __type="bool">
|
||||
<addr __type="ip4">
|
||||
<usec __type="u64">
|
||||
</hop[]>
|
||||
</traceroute>
|
||||
</call></code></pre>
|
||||
<p><code>hop</code> repeats for every hop (unsurprisingly)</p>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<traceroute status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
</body>
|
48
proto/userdata.html
Normal file
48
proto/userdata.html
Normal file
@ -0,0 +1,48 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>e-Amusement API</title>
|
||||
|
||||
<link rel="stylesheet" href="../styles.css">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<table>
|
||||
<tr>
|
||||
<td><a href="..">Contents</a></td>
|
||||
<td><a href="../transport.html">Transport layer</a></td>
|
||||
<td><a href="../packet.html">Packet format</a></td>
|
||||
<td><a href="../protocol.html">Application Protocol</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1><code>userdata</code></h1>
|
||||
<h2 id="read"><code>userdata.read</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<userdata method="read" card*="" model*="" label="" />
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<userdata status="<i>status</i>" time="">
|
||||
<b[] __type="" />
|
||||
</userdata>
|
||||
</response></code></pre>
|
||||
<p><code>__type</code> here can be either <code>bin</code> or <code>str</code></p>
|
||||
|
||||
<h2 id="write"><code>userdata.write</code></h2>
|
||||
<h3>Request:</h3>
|
||||
<pre><code><call <i>...</i>>
|
||||
<userdata method="write" card="" time="" model*="" label*="" >
|
||||
<b[] __type="str" />
|
||||
</userdata>
|
||||
</call></code></pre>
|
||||
<h3>Response:</h3>
|
||||
<pre><code><response>
|
||||
<userdata status="<i>status</i>" />
|
||||
</response></code></pre>
|
||||
</body>
|
1671
protocol.html
1671
protocol.html
File diff suppressed because it is too large
Load Diff
@ -45,6 +45,7 @@ p {
|
||||
}
|
||||
|
||||
code {
|
||||
vertical-align: middle;
|
||||
letter-spacing: .02em;
|
||||
padding: 2px 4px;
|
||||
font-size: 90%;
|
||||
@ -53,6 +54,9 @@ code {
|
||||
border-radius: 4px;
|
||||
word-break: break-word;
|
||||
}
|
||||
td > code {
|
||||
word-break: normal;
|
||||
}
|
||||
code > a {
|
||||
color: inherit;
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user