Webservice Documentation
| Method |
Returns |
Description |
| ItemBrowse |
Items |
This is the main query engine for TR's results. |
| TownGetActive |
Town[] |
Use this to get a list of all active towns on the TR network. You will need the ID's to query against ItemBrowse. Every zone also has a list of Zones. |
| CategoryGetAll |
Category[] |
Use this to get a list of all item Categories on the TR network. You will need the ID's to query against ItemBrowse. |
| GetZonesByLatLng |
Zone[] |
Give a latlong and we'll tell you what zones you are in. Called "Areas" on the main web application. |
| GetZonesByTown |
Zone[] |
A get all the Zones for a given Town. |
ItemBrowse
| Param |
Type |
Description |
| startIDX |
int |
To page through the results you can set the starting IDX. 0 = start of results. |
| pageSize |
int |
Size of Result set per Page. Max = 50. |
| tagFilter |
string |
Narrow results that have certian tags, i.e. "bar", "dvd", "take-out" etc. |
| categoryID |
Guid |
The GUID of the category you wish to narrow item results on. Empty GUID = All |
| searchString |
string |
A Search phrase to narrow results. Empty string = no search. |
| townID |
Guid |
Guid of the Town you wish to narrow on. Required. |
| zoneID |
Guid |
Guid of a Zone you wish to narrow results on. Empty GUID = All |
GetZonesByLatLng
| Param |
Type |
Description |
| townID |
Guid |
Manditory. |
| lat |
double |
|
| lng |
double |
|
GetZonesByTown
| Param |
Type |
Description |
| townID |
Guid |
Manditory. |
If you have any comments/suggestions about this webservice, please contact us at admin@townrenowned.com. We are unsure of how developers will want to use this API so any feedback is welcomed!