docs/templates/pages/proto/facility.html

{% extends "base.html" %}
{% block body %}
<h1><code>facility</code></h1>
<h2 id="get"><code>facility.get</code></h2>
<h3>Request:</h3>
<pre><code>&lt;call <i>...</i>&gt;
    &lt;facility method="get" privateip*="" encoding*="" /&gt;
&lt;/call&gt;</code></pre>
<h3>Response:</h3>
<pre><code>&lt;response&gt;
    &lt;facility expire=""\ status="<i>status</i>"&gt;
        &lt;calendar*&gt;
            &lt;year __type="s16" /&gt;
            &lt;holiday __type="s16" /&gt;
        &lt;/calendar&gt;
        &lt;location&gt;
            &lt;id __type="str" /&gt;
            &lt;country __type="str" /&gt;
            &lt;region __type="str" /&gt;
            &lt;name __type="str" /&gt;
            &lt;type __type="u8" /&gt;
            &lt;countryname __type="str" /&gt;
            &lt;countryjname __type="str" /&gt;
            &lt;regionname __type="str" /&gt;
            &lt;regionjname __type="str" /&gt;
            &lt;customercode __type="str" /&gt;
            &lt;companycode __type="str" /&gt;
            &lt;latitude __type="s32" /&gt;
            &lt;longitude __type="s32" /&gt;
            &lt;accuracy __type="u8" /&gt;
        &lt;/location&gt;
        &lt;line&gt;
            &lt;id __type="str" /&gt;
            &lt;class __type="u8" /&gt;
        &lt;/line&gt;
        &lt;portfw&gt;
            &lt;globalip __type="ip4" /&gt;
            &lt;globalport __type="s16" /&gt;
            &lt;privateport __type="s16" /&gt;
        &lt;/portfw&gt;
        &lt;public&gt;
            &lt;flag __type="u8" /&gt;1&lt;/ flag&gt;
            &lt;name __type="str" /&gt;
            &lt;latitude __type="str"&gt;0&lt;latitude&gt;
            &lt;longitude __type="str"&gt;0&lt;longitude&gt;
        &lt;/public&gt;
        &lt;share&gt;
            &lt;eapass*&gt;
                &lt;valid __type="?" /&gt;
            &lt;/eapass&gt;
            &lt;eacoin&gt;
                &lt;notchamount __type="s32" /&gt;
                &lt;notchcount __type="s32" /&gt;
                &lt;supplylimit __type="s32"&gt;100000&lt;supplylimit&gt;
            &lt;/eacoin&gt;
            &lt;url&gt;
                &lt;eapass __type="str"&gt;www.ea-pass.konami.net&lt;eapass&gt;
                &lt;arcadefan __type="str"&gt;www.konami.jp/am&lt;arcadefan&gt;
                &lt;konaminetdx __type="str"&gt;http://am.573.jp&lt;konaminetdx&gt;
                &lt;konamiid __type="str"&gt;http://id.konami.jp&lt;konamiid&gt;
                &lt;eagate __type="str"&gt;http://eagate.573.jp&lt;eagate&gt;
            &lt;/url&gt;
        &lt;/share&gt;
    &lt;/facility&gt;
&lt;/response&gt;</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>
{% endblock %}