Difference between revisions of "Linden Lab Official:Registration API Reference"

From Second Life Wiki
Jump to navigation Jump to search
Line 3: Line 3:
== check_name ==
== check_name ==


The check_name POST operation checks to see if a user can be registered with a given Second Life first name and last name.
'''HTTP method''': POST
 
The check_name operation checks to see if a user can be registered with a given Second Life first name and last name.


=== Parameters ===
=== Parameters ===
Line 45: Line 47:
== create_user ==
== create_user ==


The create_user POST operation creates a new Second Life Resident (user) account.  POST to this URL a LLSD document containing at least the following parameters:
'''HTTP method''': POST
 
The create_user operation creates a new Second Life Resident (user) account.  POST to this URL a LLSD document containing at least the following parameters:
* username  
* username  
* last_name_id  
* last_name_id  
Line 185: Line 189:
== get_error_codes ==
== get_error_codes ==


The get_error_codes operation returns an LLSD document describing the Reg API error codes.  This information is reproduced in [[Registration API Error Codes]].  This GET operation does not take any parameters.
'''HTTP method''': GET
 
The get_error_codes operation returns an LLSD document describing the Reg API error codes.  This information is reproduced in [[Registration API Error Codes]].  This operation does not take any parameters.


The errors are in an array, and each error is, in addition, contained in an array. The first element in the array is the error code, the second is the name of the error, the third is the description.
The errors are in an array, and each error is, in addition, contained in an array. The first element in the array is the error code, the second is the name of the error, the third is the description.
Line 216: Line 222:
== get_last_names ==
== get_last_names ==


The get_last_names GET operation retrieves the last names and corresponding IDs with which you are able to register new users.   
'''HTTP method''': GET
 
The get_last_names operation retrieves the last names and corresponding IDs with which you are able to register new users.   


=== Example ===
=== Example ===
Line 238: Line 246:
  </llsd>
  </llsd>


===DTD===
== get_reg_capabilities ==
 
This simplified version of the full [[LLSD#DTD|LLSD DTD]], enables stricter validation of result documents.
 
<div style="font-size:1.2em;"><xml><!DOCTYPE llsd [
<!ELEMENT llsd (map)>
<!ELEMENT map ((key,string)*)>
<!ELEMENT key (#PCDATA)>
<!ELEMENT string (#PCDATA)>
 
<!ATTLIST string xml:space (default|preserve) 'preserve'>
]></xml></div>


== get_reg_capabilities ==
'''HTTP method''': POST


This POST operation returns the capability URL for each operation for which your account is authorized.
This operation returns the capability URL for each operation for which your account is authorized.


URI: https://cap.secondlife.com/get_reg_capabilities
URI: https://cap.secondlife.com/get_reg_capabilities
Line 265: Line 262:
For more information on capability URLs, see [[Registration_API#Using_capability_URLs|Using capability URLs]].
For more information on capability URLs, see [[Registration_API#Using_capability_URLs|Using capability URLs]].


===DTD===
==DTD==


This simplified version of the full [[LLSD#DTD|LLSD DTD]], enables stricter validation of result documents.
This simplified version of the full [[LLSD#DTD|LLSD DTD]], enables stricter validation of result documents.


<div style="font-size:1.2em;"><xml><!DOCTYPE llsd [
<div style="font-size:0.9em;"><xml><!DOCTYPE llsd [
<!ELEMENT llsd (map)>
<!ELEMENT llsd (map)>
<!ELEMENT map ((key,(string|uri))*)>
<!ELEMENT map ((key,(string|uri))*)>
Line 278: Line 275:
<!ATTLIST string xml:space (default|preserve) 'preserve'>
<!ATTLIST string xml:space (default|preserve) 'preserve'>
]></xml></div>
]></xml></div>


[[Category:RegAPI|Documentation]]
[[Category:RegAPI|Documentation]]
[[Category:Web Service APIs]]
[[Category:Web Service APIs]]

Revision as of 12:31, 28 July 2009

check_name

HTTP method: POST

The check_name operation checks to see if a user can be registered with a given Second Life first name and last name.

Parameters

POST the new user's desired "username" and "last_name_id", and the Reg API returns an LLSD document that contains a Boolean value indicating whether the name is available.

Setting Data type Description Default Value
username String Desired user name (Second Life first name). Must be between 2-31 alphanumeric characters. Certain first names are restricted; for example, those considered obscene or inappropriate for public use. Required parameter.
last_name_id Integer ID of desired Second Life last name. Required parameter.

Example

Posted message:

<llsd> 
  <map> 
      <key>username</key><string>mistaht</string> 
      <key>last_name_id</key><integer>1872</integer> 
  </map> 
</llsd>

Reply message:

<llsd> 
  <boolean>true</boolean> 
</llsd>

create_user

HTTP method: POST

The create_user operation creates a new Second Life Resident (user) account. POST to this URL a LLSD document containing at least the following parameters:

  • username
  • last_name_id
  • email
  • dob
  • password

In addition, you can include any of the optional parameters listed in the table below.

If successful, the Reg API will return a hash containing the new user's agent_id. If there are errors, the Reg API will instead return an array containing the applicable error codes will be returned.

Parameters

Setting Data type Description Default Value
username String Desired user name (Second Life first name). Must be between 2-31 alphanumeric characters. Certain first names are restricted; for example, those considered obscene or inappropriate for public use. Required parameter.
last_name_id Integer ID of desired Second Life last name. Required parameter.
email String User's email address. Required parameter.
password String Desired password. Must be between 6-16 characters. Required parameter.
dob String User's date of birth in the YYYY-MM-DD format. Users under 18 cannot be registered to the mainland. See limited_to_estate. Required parameter.
limited_to_estate Integer ID of estate that the user will be limited to. To change this to another estate, you must own the estate. Optional parameter. Estate 1, the mainland.
start_region_name String Region where user will initially appear after login. This can only be set to simulators in the user's limited to estate. Optional parameter. Orientation island of the estate.
start_local_x Float X coordinate of the starting region. Must be between 0-256. Value must have two decimal places, for example: 123.00.

Optional parameter; valid only when start_region_name is set.

128 (center).
start_local_y Float Y coordinate of the starting region. Must be between 0-256. Value must have two decimal places, for example: 123.00.

Optional parameter; valid only when start_region_name is set.

128 (center).
start_local_z Float Z coordinate of the starting region. Must be between 0-256. Value must have two decimal places, for example: 123.00.

Optional parameter; valid only when start_region_name is set.

128 (center).
start_look_at_x Float X component of the unit vector representing initial look direction. Must be between 0-1.

Optional parameter; valid only when start_region_name is set.

0
start_look_at_y Float Y component of the unit vector representing initial look direction. Must be between 0-1.

Optional parameter; valid only when start_region_name is set.

1

NOTE: You can get the numeric estate ID via the debug menus (Ctrl+Alt+Shift+D to enable them). Then use Client > View Admin Options. This will allow you to view, but not use, the options that admins (Lindens) can use. Now go to the Server menu, which appeared with the Client one. Select God Tools, look at the Region tab... the Estate ID is listed there. Don't worry about pressing or changing something you shouldn't... as they are just viewable options, any changes you make won't stick.

Return value

If the operation successfully creates a new user, it returns a document like this:

<llsd> 
  <map> 
      <key>agent_id</key> 
      <string>UNIQUE_ID</string> 
  </map> 
</llsd>

Where UNIQUE_ID is the new user's unique Second Life ID number.

If the operation is not successful, then it returns an array of error codes similar to that returned by get_error_codes.

Example

Posted message:

<llsd>
  <map>
    <key>dob</key><string>1987-07-06</string>
    <key>start_region_name</key><string>da boom</string>
    <key>username</key><string>mistaht</string>
    <key>last_name_id</key><integer>1872</integer>
    <key>password</key><string>123456</string>
    <key>email</key><string>ben@ben.com</string>
  </map>
</llsd>

Reply message:

<llsd> 
  <map> 
      <key>agent_id</key> 
      <string>87cfdb64-c852-4359-ae16-dce36099ff68</string> 
  </map> 
</llsd>

get_error_codes

HTTP method: GET

The get_error_codes operation returns an LLSD document describing the Reg API error codes. This information is reproduced in Registration API Error Codes. This operation does not take any parameters.

The errors are in an array, and each error is, in addition, contained in an array. The first element in the array is the error code, the second is the name of the error, the third is the description.

Example

The following HTML code illustrates a simple form to get the error codes:

<form action="https://cap.secondlife.com/cap/0/UUID" method="GET">
   <input type='submit' value="Get Error Codes">
</form>

Example response:

<llsd> 
   </array> 
       <array> 
           <integer>20</integer> 
           <string>missing required field</string> 
           <string>You are missing one of the required fields</string> 
       </array> 
... 
       <array> 
           <integer>1500</integer> 
           <string>malformed xml</string> 
           <string>Your xml is malformed</string> 
       </array> 
   </array> 
</llsd>

get_last_names

HTTP method: GET

The get_last_names operation retrieves the last names and corresponding IDs with which you are able to register new users.

Example

The following HTML code illustrates a simple form to get the valid last names:

<form action="https://cap.secondlife.com/cap/0/UUID" method="GET">
   <input type="submit" value="Get Last Names">
</form>

Example response:

<llsd> 
  <map> 
      <key>1926</key><string>Morellet</string> 
      <key>1683</key><string>Okamoto</string> 
      <key>1738</key><string>Rankin</string> 
... 
      <key>1870</key><string>Yang</string> 
  </map> 
</llsd>

get_reg_capabilities

HTTP method: POST

This operation returns the capability URL for each operation for which your account is authorized.

URI: https://cap.secondlife.com/get_reg_capabilities

POST parameters

  • first_name (Second Life first name)
  • last_name (Second Life surname)
  • password

For more information on capability URLs, see Using capability URLs.

DTD

This simplified version of the full LLSD DTD, enables stricter validation of result documents.

<xml><!DOCTYPE llsd [

<!ELEMENT llsd (map)> <!ELEMENT map ((key,(string|uri))*)> <!ELEMENT key (#PCDATA)> <!ELEMENT string (#PCDATA)> <!ELEMENT uri (#PCDATA)>

<!ATTLIST string xml:space (default|preserve) 'preserve'>

]></xml>