There are several APIs you can use to manage users and Regions within your Breakroom World. Learn how to add users, delete users, update Regions, and more.
Overview
Breakroom APIs require specific access to be granted to your account. If you are the World Owner, this access should be automatically enabled on your user account.
In this section of the documentation, you will see Breakroom Worlds referred to as grids. Because Breakroom is based on the Sinespace virtual world platform, you may also see the name Sinespace used instead of Breakroom.
You may send parameters as either POST form_data, or as Query parameters on the URL.
All APIs require you send three additional POST parameters:adminname, adminpwd,and gridid.These should be the username and password of an account on the grid with administrator rights, along with the grid with which you intend to interface. We recommend creating a new user for this role specifically.
This endpoint allows you to register new users automatically.
Query Parameters
Name
Type
Description
gridid
integer
The unique grid ID where the user will be registered.
password
string
The user's initial password.
email
string
The user's e-mail address. We will not send any messages to this address unless requested by the user (e.g., password reset).
username
string
The desired username. If a particular username is already taken, an iteration on the provided name will be assigned to the account (e.g. "User Name01").
playeroutfitid
integer
The "Outfit ID" the user should be wearing when they first log in. As this creates "free" copies of items that may be listed as paid items on the Sine Wave Shop, the creator of the items must be an Administrator of the grid in question.
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>Region APIs
Create Region
Creates a new region on the grid
The user ID to be marked as owner of the region
The item ID for the region template to use
Either "0" for no access, "1" for free-for-all access, "2" for friends-only access, and "3" for approved only access.
The name of the region you wish to create
Region was created successfully
<?xml version="1.0" encoding="utf-8"?>
<CreateRegionResponse><RegionID>152860</RegionID></CreateRegionResponse>
An error was found in the inputs
<?xml version="1.0" encoding="utf-8"?>
<Response><code>0</code><message>Room template not available, please try another.</message></Response>
Set Region Role
The ID of the region
The ID of the user in question
Either "Normal", "Admin", or "Blocked".
<?xml version="1.0" encoding="utf-8"?>
<Response><code>1</code><message></message></Response>
<?xml version="1.0" encoding="utf-8"?>
<Response><code>0</code><message>The data provided is incorrect: role = abc</message></Response>
Get Regions
Requests a list of regions on the Grid
Offsets the results if there is too many to return in a single query.
Return regions owned by this account
A CSV separated list of region IDs to return information about.
<?xml version="1.0" encoding="utf-8"?>
<GetRegionsResponse><Regions><RegionID>50000040</RegionID><RegionName>regionname</RegionName><Owner>2099564</Owner><TemplateID>11</TemplateID><AccessLevel>3</AccessLevel></Regions><Regions><RegionID>50000039</RegionID><RegionName>regionname2</RegionName><Owner>2099563</Owner><TemplateID>11</TemplateID><AccessLevel>1</AccessLevel></Regions><GetRegionsResponse>
Update Region
Updates information about a particular region
The region ID to update information about
If present, changes the name of the region
If present, changes the template of the region to the specified template ID
Either "0" - no access, "1" - free access, "2" friends-only access, and "3" approved only access.
