31 lines
1.3 KiB
XML
31 lines
1.3 KiB
XML
<xml>
|
|
<brief>Get information on this OKAPI installation</brief>
|
|
<issue-id>14</issue-id>
|
|
<desc>
|
|
Retrieve some basic information about this OKAPI installation.
|
|
</desc>
|
|
<common-format-params/>
|
|
<returns>
|
|
<p>A dictionary of the following structure:</p>
|
|
<ul>
|
|
<li>
|
|
<b>site_url</b> - URL of the Opencaching site which is running
|
|
the OKAPI installation (usually this looks like
|
|
"http://www.opencaching.<i>xx</i>/", where <b>xx</b> is a top
|
|
level domain of a country).
|
|
</li>
|
|
<li>
|
|
<b>okapi_base_url</b> - URL of the OKAPI installation (usually this is
|
|
<b>site_url</b> with "okapi/" appended, but you should not assume
|
|
that); this value is to be used as a prefix when constructing service
|
|
method URLs,
|
|
</li>
|
|
<li>
|
|
<b>site_name</b> - international name of the Opencaching site,
|
|
</li>
|
|
<li><b>okapi_revision</b> - integer, an SVN revision of the OKAPI project
|
|
installed on this Opencaching site, <b>or null</b>, when could not
|
|
determine revision number.</li>
|
|
</ul>
|
|
</returns>
|
|
</xml> |