docs/templates/pages/proto/facility.html

121 lines
3.6 KiB
HTML
Raw Normal View History

2021-12-28 20:54:12 +00:00
{% extends "base.html" %}
2021-12-29 01:41:21 +00:00
{% block title %}facility{% endblock %}
2021-12-28 20:54:12 +00:00
{% block body %}
<h1><code>facility</code></h1>
<h2 id="get"><code>facility.get</code></h2>
<h3>Request:</h3>
2021-12-28 22:29:33 +00:00
<pre>{% highlight "cxml" %}<call ...>
<facility method="get" privateip*="" encoding*="" />
</call>{% endhighlight %}</pre>
2021-12-28 20:54:12 +00:00
<h3>Response:</h3>
2021-12-28 22:29:33 +00:00
<pre>{% highlight "cxml" %}<response>
<facility expire="" status="??status">
<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" />
2021-12-31 22:07:46 +00:00
<globalport __type="u16" />
<privateport __type="u16" />
2021-12-28 22:29:33 +00:00
</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>{% endhighlight %}</pre>
2021-12-28 20:54:12 +00:00
<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>
2021-12-28 00:26:42 +00:00
<tr>
2021-12-28 20:54:12 +00:00
<td>Country</td>
<td>Code</td>
2021-12-28 00:26:42 +00:00
</tr>
2021-12-28 20:54:12 +00:00
</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>
{% endblock %}