GridService - Revision history

BlueWall: /* API */

2014-08-06T19:03:26Z

‎API

Justincc at 00:36, 30 July 2014

2014-07-30T00:36:28Z

Justincc: /* Calls */

2014-07-30T00:12:49Z

‎Calls

Justincc: /* Calls */

2014-07-30T00:07:09Z

‎Calls

Justincc: /* API */

2014-07-30T00:02:35Z

‎API

Justincc: /* API */

2014-07-30T00:02:26Z

‎API

Justincc: /* API */

2014-07-29T23:43:59Z

‎API

Justincc at 23:24, 29 July 2014

2014-07-29T23:24:12Z

Justincc: /* Methods */

2014-07-29T23:23:48Z

‎Methods

Justincc: Add intro section

2014-07-29T23:13:07Z

Add intro section

@@ Line 21: / Line 21: @@
 * get_hyperlinks - get linked Hypergrid regions.
 * get_region_flags - get flags for a region.
 == Formats ==

@@ Line 1: / Line 1: @@
 = Introduction =
-The grid service manages information about regions on the grid.
+The grid service manages information about regions on the grid.  Some of the API is a little odd - this is a legacy of its original undocumented private-only use.
 = API =

@@ Line 70: / Line 70: @@
 == Calls ==
 === get_region_by_uuid ===
@@ Line 81: / Line 130: @@
 * '''SCOPEID''' must always be present and always 00000000-0000-0000-0000-000000000000 (UUID.Zero) at the present time.
-* '''REGIONID''' is the UUID of region to query for flags.
+* '''REGIONID''' is the UUID of region to get.
 If there are any regions in the range, a response like

← Older revision		Revision as of 00:07, 30 July 2014
Line 70:		Line 70:

	== Calls ==		== Calls ==
		+
		+	=== get_region_by_uuid ===
		+	This gets information on the region with the given UUID.
		+
		+	The POST field is a urlencoded string like so
		+
		+	SCOPEID=00000000-0000-0000-0000-000000000000&REGIONID=dd5b77f8-bf88-45ac-aace-35bd76426c81&METHOD=get_region_by_uuid
		+
		+	where
		+
		+	* '''SCOPEID''' must always be present and always 00000000-0000-0000-0000-000000000000 (UUID.Zero) at the present time.
		+	* '''REGIONID''' is the UUID of region to query for flags.
		+
		+	If there are any regions in the range, a response like
		+
		+	<source lang='xml'>
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<result type="List">
		+	<uuid>dd5b77f8-bf88-45ac-aace-35bd76426c81</uuid>
		+	<locX>256000</locX>
		+	<locY>256000</locY>
		+	<sizeX>256</sizeX>
		+	<sizeY>256</sizeY>
		+	<regionName>test</regionName>
		+	<serverIP>192.168.1.2</serverIP>
		+	<serverHttpPort>9000</serverHttpPort>
		+	<serverURI>http://192.168.1.2:9000/</serverURI>
		+	<serverPort>9000</serverPort>
		+	<regionMapTexture>fc8fda13-c2e9-4e83-8543-b7fe98231399</regionMapTexture>
		+	<parcelMapTexture>00000000-0000-0000-0000-000000000000</parcelMapTexture>
		+	<access>13</access>
		+	<regionSecret>0ab0a97d-ffcc-4b29-a715-74372b763b88</regionSecret>
		+	<owner_uuid>f2f493c0-27d3-4cf2-be97-b44dfdad13b6</owner_uuid>
		+	<Token/>
		+	</result>
		+	</ServerResponse>
		+	</source>
		+
		+	If no matching regions are found then
		+
		+	<source lang='xml'>
		+	<?xml version="1.0"?>
		+	<ServerResponse>
		+	<result>null</result>
		+	</ServerResponse>
		+	</source>
		+
		+	will be returned.

	=== get_region_flags ===		=== get_region_flags ===

@@ Line 19: / Line 19: @@
 * get_hyperlinks - get linked Hypergrid regions.
 * get_region_flags - get flags for a region.
 == Formats ==

@@ Line 21: / Line 21: @@
 == Calls ==
 === get_region_range ===
@@ Line 32: / Line 76: @@
 * '''SCOPEID''' must always be present and always 00000000-0000-0000-0000-000000000000 (UUID.Zero) at the present time.
-* '''XMIN''' The minimum x-coordinate in the region range.  Please note that this is in meters, not 256m map tiles.  So to start this at map tile co-ordinate 1000, one must specify 256000 (1000 * 256).
+* '''XMIN''' The minimum x-coordinate in the region range.  Please note that this is in meters, not 256m map tiles.  This must be in the range 0 - 2147483647.  So to start this at map tile co-ordinate 1000, one must specify 256000 (1000 * 256).
-* '''YMIN''' The minimum u-coordinate in the region range.  Please note that this is in meters, not 256m map tiles.
+* '''YMIN''' The minimum u-coordinate in the region range.  Please note that this is in meters, not 256m map tiles.  This must be in the range 0 - 2147483647.
-* '''XMAX''' The maximum x-coordinate in the region range.  Please note that this is in meters, not 256m map tiles.
+* '''XMAX''' The maximum x-coordinate in the region range.  Please note that this is in meters, not 256m map tiles.  This must be in the range 0 - 2147483647.
-* '''XMIN''' The maximum y-coordinate in the region range.  Please note that this is in meters, not 256m map tiles.
+* '''XMIN''' The maximum y-coordinate in the region range.  Please note that this is in meters, not 256m map tiles.  This must be in the range 0 - 2147483647.
 If there are any regions in the range, a response like
@@ Line 91: / Line 135: @@
 will be returned.

@@ Line 3: / Line 3: @@
 The grid service manages information about regions on the grid.
-= Methods =
+= API =
-Methods available on the grid service are
+Functions available on the grid service are
 * register - registers a region with the grid.
@@ Line 19: / Line 19: @@
 * get_hyperlinks - get linked Hypergrid regions.
 * get_region_flags - get flags for a region.

← Older revision		Revision as of 23:13, 29 July 2014
Line 1:		Line 1:
		+	= Introduction =
		+
		+	The grid service manages information about regions on the grid.
		+
	= Methods =		= Methods =
	Methods available on the grid service are		Methods available on the grid service are