Geo
GetCountriesList [finished]
Overlays:
Activation:
GetCountriesList.php ? sessionID = ...
Description:
Returns list of countries.
Parameters:
- sessionID: string(16)
Results:
<GetCountriesList>
<status>OK</status>
<countriesNumber>12</countriesNumber> : uint - records number
<countries>
<country>
<countryID>42</countryID> : uint
<name>Poland</name> : string(255)
<code>pl</code> : string(2)
</country>
</countries>
</GetCountriesList>
Throw Errors:
GetTimeZonesList [finished]
Overlays:
Activation:
GetTimeZonesList.php ? sessionID = ...
[ & countryCodes = ... ]
Description:
Returns list of time zones for given countries.
Parameters:
- sessionID: string(16)
- countryCodes: enum('pl','gb', ...) list
Results:
<GetTimeZonesList>
<status>OK</status>
<timeZonesNumber>12</timeZonesNumber> : uint - records number
<timeZones>
<timeZone>
<timeZoneID>283</timeZoneID> : uint
<name>Warsaw</name> : string(255)
<code>pl</code> : string(2)
</timeZone>
</timeZones>
</GetTimeZonesList>
Throw Errors:
GetRegionsList [finished]
Overlays:
Activation:
GetRegionsList.php ? sessionID = ... & countryID = ...
Description:
Returns list of regions for given countryID.
Parameters:
- sessionID: string(16)
- countryID: uint
Results:
<GetRegionsList>
<status>OK</status>
<regionsNumber>12</regionsNumber> : uint - records number
<regions>
<region>
<regionID>1</regionID> : uint
<countryID>1</countryID> : uint
<name>Mazowsze</name> : string(255)
</region>
</regions>
</GetRegionsList>
Throw Errors:
GetCitiesList [finished]
Overlays:
Activation:
GetCitiesList.php ? sessionID = ... & countryID = ... & regionID = ...
[ & cityIDs = ... ]
Description:
Returns list of cities matching specified criteria.
Parameters:
- sessionID: string(16)
- countryID: uint
- regionID: uint
- cityIDs: uint list
Results:
<GetCitiesList>
<status>OK</status>
<citiesNumber>12</citiesNumber> : uint - records number
<cities>
<city>
<cityID>1</cityID> : uint
<countryID>1</countryID> : uint
<regionID>1</regionID> : uint
<name>Warsaw</name> : string(255)
<latitude>522166</latitude> : int - geographic coordinates * 10000
<longitude>210000</longitude> : int - : geographic coordinates * 10000
</city>
</cities>
</GetCitiesList>
Throw Errors:
GetLanguagesList [finished]
Overlays:
Activation:
GetLanguagesList.php ? sessionID = ...
[ & namepattern = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns list of languages matching specified criteria.
Parameters:
- sessionID: string(16)
- namepattern: string(100)
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetLanguagesList>
<status>OK</status>
<languagesNumber>12</languagesNumber> : uint - all records number (if there were no limit and offset)
<languages>
<language>
<languageID>40</languageID> : uint
<name>English</name> : string(255)
<codePage>iso-8859-1</codePage> : string(20)
<code>en</code> : string(2)
</language>
</languages>
</GetLanguagesList>