RemoteAdmin:admin region query - Revision history

JeffKelley: /* PHP */ Fixed broken Google Code link, replacing with internal page

2021-03-16T19:37:51Z

‎PHP: Fixed broken Google Code link, replacing with internal page

Fritigern at 23:28, 24 October 2015

2015-10-24T23:28:41Z

Justincc: /* PHP */

2013-11-08T00:01:33Z

‎PHP

MakoBot: Robot: Cosmetic changes

2012-03-04T04:06:49Z

Robot: Cosmetic changes

Michelle Argus: /* Optional Parameters */

2012-01-15T11:11:25Z

‎Optional Parameters

Michelle Argus at 17:42, 10 December 2011

2011-12-10T17:42:42Z

Michelle Argus: moved Remoteadmin:admin region query to RemoteAdmin:admin region query: spelling

2011-12-10T15:23:40Z

moved Remoteadmin:admin region query to RemoteAdmin:admin region query: spelling

Michelle Argus at 22:12, 9 December 2011

2011-12-09T22:12:17Z

Michelle Argus: /* Enabling admin_modify_region */

2011-12-09T17:35:14Z

‎Enabling admin_modify_region

Michelle Argus: Created page with "'''admin_region_query''' remotely allows quary the "health" of a region. === Enabling admin_modify_region === If not all functions are enabled, use admin_region_query to enabl..."

2011-12-09T17:29:35Z

Created page with "'''admin_region_query''' remotely allows quary the "health" of a region. === Enabling admin_modify_region === If not all functions are enabled, use admin_region_query to enabl..."

New page

'''admin_region_query''' remotely allows quary the "health" of a region.

=== Enabling admin_modify_region ===
If not all functions are enabled, use admin_region_query to enable the function in the [RemoteAdmin] section
<source lang="csharp">
enabled_methods = admin_region_query,...
</source>

== Parameters ==
=== Required Parameters ===
These parameters are required
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''region_name''
| Name of the region, optionaly use region_uuid
|
|}

=== Optional Parameters ===
These parameters are optional and do not need to be set
{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''region_uuid''
| region uuid of the region.
|
|}

== Returned Parameters ==
=== Returned Parameters ===
These parameters are returned by Remote Admin

{| cellspacing="0" cellpadding="4" border="1"
|-
! parameter
! Description
! Values
|-
| ''success''
| true when successfull
| true, false
|-
|''error''
| error message when not successfull
|
|-
| ''health''
| health data of the region
|integer value
|}

=== Error messages ===
When an error occures the following error value are returned

*failed to switch to region {REGION NAME}
*failed to switch to region {REGION UUID}
*neither region_name nor region_uuid given

== Notes ==

== Example ==
=== PHP ===
<source lang="php">
<?php

// Including the RemoteAdmin PHP class.
include('RemoteAdmin.php');

// Instantiate the class with parameters identical to the Python example above
$myRemoteAdmin = new RemoteAdmin('127.0.0.1', 9000, 'secret');

// Invoke admin_create_user (multiple parameters)
$parameters = array('region_name' => 'My Plaza');
$myRemoteAdmin->SendCommand('admin_region_query', $parameters);
?>
</source>

[[Category:Development]]

@@ Line 91: / Line 91: @@
 </source>
 [[RemoteAdmin]]
-[[RemoteAdmin:Commands]]

← Older revision		Revision as of 17:42, 10 December 2011
Line 90:		Line 90:
	</source>		</source>

−	[[~~Category~~:~~Development~~]]	+	[[RemoteAdmin]]
		+	[[RemoteAdmin:Commands]]

← Older revision		Revision as of 22:12, 9 December 2011
Line 1:		Line 1:
−	'''admin_region_query''' remotely allows ~~quary~~ the "health" of a region.	+	'''admin_region_query''' remotely allows to query the "health" of a region.

@@ Line 74: / Line 74: @@
 == Example ==
 === PHP ===
-This example needs the RemoteAdmin PHP Class file available [http://code.google.com/p/opensimtools/wiki/RemoteAdminPHPClass here].
+This example needs the RemoteAdmin PHP Class file available [[RemoteAdmin:RemoteAdmin_Class|here]].
 <source lang="php">

@@ Line 63: / Line 63: @@
 When an error occures the following error value are returned
-*failed to switch to region {REGION NAME}
+* failed to switch to region {REGION NAME}
-*failed to switch to region {REGION UUID}
+* failed to switch to region {REGION UUID}
-*neither region_name nor region_uuid given
+* neither region_name nor region_uuid given

@@ Line 31: / Line 31: @@
 ! Values
 |-
-| ''region_uuid''
+| ''region_id''
 | region uuid of the region.
+|
 |}
 == Returned Parameters ==

@@ Line 2: / Line 2: @@
-=== Enabling admin_modify_region ===
+=== Enabling admin_region_query ===
 If not all functions are enabled, use admin_region_query to enable the function in the [RemoteAdmin] section
 <source lang="csharp">