Difference between revisions of "HTTP API/Bot Commands/name2key"
From SmartBots Developers Docs
(Created page with "{{DISPLAYTITLE: name2key}} <onlyinclude>Returns avatar UUID by Second Life name.</onlyinclude> {{API Variables Table}} {{API HTTP Required Vars|name2key|Standard bot}} {{AP...") |
|||
| Line 8: | Line 8: | ||
{{API Variable Group|Input}} | {{API Variable Group|Input}} | ||
{{API Variable|name|yes}} the Second Life name of the avatar | {{API Variable|name|yes}} the Second Life name of the avatar | ||
| + | {{API Variable|request_case|optional}} set to 1 if you want to get the exact avatar name case from Second Life (see Name case) | ||
{{API Variable Group|Output}} | {{API Variable Group|Output}} | ||
| Line 24: | Line 25: | ||
* name - this is the name you've sent | * name - this is the name you've sent | ||
* normalname - this is a "normalized" name: system adds "Resident" if necessary | * normalname - this is a "normalized" name: system adds "Resident" if necessary | ||
| + | |||
| + | === Name case === | ||
| + | |||
| + | SL ignores name case ("glaznah gassner" name is equal to "Glaznah GASSner"), so ''normalname'' may come lowercase. | ||
| + | |||
| + | If you want to get the exact name case from SL servers, set ''request_case'' to 1. | ||
== Example == | == Example == | ||
| Line 30: | Line 37: | ||
<syntaxhighlight lang="http"> | <syntaxhighlight lang="http"> | ||
| − | http://www.mysmartbots.com/api/bot.html?action=name2key&name= | + | http://www.mysmartbots.com/api/bot.html?action=name2key&name=barKeeeper&... |
</syntaxhighlight> | </syntaxhighlight> | ||
Result: | Result: | ||
| − | name = | + | name = barKeeeper |
| + | normalname = barkeeeper resident | ||
| + | key = 76e96174-ddcf-482f-86aa-c9394664082f | ||
| + | |||
| + | Or, with ''heyter nitely=1'': | ||
| + | |||
| + | name = barKeeeper | ||
normalname = BarKeeeper Resident | normalname = BarKeeeper Resident | ||
key = 76e96174-ddcf-482f-86aa-c9394664082f | key = 76e96174-ddcf-482f-86aa-c9394664082f | ||
Revision as of 16:32, 22 August 2016
Returns avatar UUID by Second Life name.
Variables
The following table shows input values (you send them with the API call) and returned output values.
| Variable | Required | Description | ||
|---|---|---|---|---|
| This API command applies only for Standard bot | ||||
| Input basic parameters: | ||||
| action | yes | = name2key | ||
| apikey | yes | Your personal developer's API key. | ||
| botname | yes | Your bot's SL login. | ||
| secret | yes | Bot access code of your bot. | ||
| dataType | optional | Set to "json" to get JSON reply instead of URL-encoded string | ||
| custom | optional | The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response. | ||
| Input: | ||||
| name | yes | the Second Life name of the avatar | ||
| request_case | optional | set to 1 if you want to get the exact avatar name case from Second Life (see Name case) | ||
| Output: | ||||
| (to be received in http_response LSL event, see docs for details) | ||||
| result | OK - command completed successfully FAIL - command failed | |||
| resulttext | Detailed reason for the failure. | |||
| custom | The value from input "custom" parameter. See above. | |||
| key | Avatar's UUID | |||
| name | Second Life name you've sent | |||
| normalname | Second Life name, normalized (see "Return value") | |||
Return value
The command returns avatar's UUID by searching its Second Life name. Command returns two values:
- uuid - this is the UUID
- name - this is the name you've sent
- normalname - this is a "normalized" name: system adds "Resident" if necessary
Name case
SL ignores name case ("glaznah gassner" name is equal to "Glaznah GASSner"), so normalname may come lowercase.
If you want to get the exact name case from SL servers, set request_case to 1.
Example
1. Requesting the avatar UUID by Second Live name:
http://www.mysmartbots.com/api/bot.html?action=name2key&name=barKeeeper&...
Result:
name = barKeeeper normalname = barkeeeper resident key = 76e96174-ddcf-482f-86aa-c9394664082f
Or, with heyter nitely=1:
name = barKeeeper normalname = BarKeeeper Resident key = 76e96174-ddcf-482f-86aa-c9394664082f
2. Looking for an unexistent avatar
http://www.mysmartbots.com/api/bot.html?action=name2key&name=ThisAvatarNotExists&...
Result:
result = FAIL resulttext = name lookup failed, ThisAvatarNotExists Resident normalname = ThisAvatarNotExists Resident name = ThisAvatarNotExists
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
