33 lines
1.3 KiB
XML
33 lines
1.3 KiB
XML
<xml>
|
|
<brief>Get the list of all public OKAPI installations</brief>
|
|
<issue-id>39</issue-id>
|
|
<desc>
|
|
Get the list of all public OKAPI installations. Keep in mind that
|
|
OKAPI installations might differ slightly. If you plan on using
|
|
multiple OKAPI installations in your application (which is a very
|
|
good thing!) you should test it against the one with the <b>lowest</b>
|
|
OKAPI revision number.
|
|
</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>site_name</b> - universal name for this site (should be fine
|
|
for all languages),
|
|
</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>
|
|
</ul>
|
|
</returns>
|
|
</xml> |