Accessing Workspace Data using the Brillium Web API
Each Brillium organization has at least one Workspace, called the Primary Workspace (indicated by a crown icon in the Workspace list). Workspaces organize assessments much like file folders, and also serve to apply common settings among the assessments that reside within them. Like file folders, Workspaces may other Workspaces that form part of the Workspace hierarchy.
IMPORTANT NOTE
With the changes to the Brillium security architecture beginning with Brillium versions 10 and 11, "Accounts" are now referred to as "Workspaces". In the current version of the Web API documentation, and API call that refers to accounts will referring to Workspace for users on Brillium 10 and higher.
Any API documentation call references to accounts will use and return Workspace names.
We urge developers to subscribe to Brillium update notifications at https://status.brillium.com to stay informed about changes that affect Developer resources in forthcoming releases.
Workspace Object (formerly Account and Sub-Accounts)
Object Properties
| Property | Type | Description |
Id | String | A unique identifier for the Workspace It may be a maximum of 25 characters in length. |
ParentAccountId | String | The Id of the primary Workspace, if not the Primary Workspace. This will be an empty string if the Workspace is the Primary Workspace. |
| Scalar Properties | ||
Password | String | (Deprecated) Will always return “******” to protect the security of the Workspace. |
Name | String | The name of the Workspace. Often this will indicate the purpose of the Workspace or the group using the Workspace, not the person owning the Workspace. |
ContactName | String | This is the name of the person that owns or controls the Workspace. |
ContactTitle | String | The title or position of the person owning the Workspace. |
ContactAddress1 | String | The address of the person owning the Workspace. |
ContactAddress2 | String | The address of the person owning the Workspace. |
ContactAddress3 | String | The address of the person owning the Workspace. |
ContactCity | String | The city of the person owning the Workspace. |
ContactState | String | The state of the person owning the WOrkspace. |
ContactPostalCode | String | The zip or postal code of the person owning the Workspace. |
ContactCountry | String | The country of the person owning the Workspace. |
ContactPhone | String | The phone number of the person owning the Workspace. |
ContactFax | String | The fax number of the person owning the Workspace. |
ContactEmail | String | The email address of the person owning the Workspace. |
DateCreated | Date | The date the Workspace was created. |
DateModified | Date | The date the Workspace was last modified. |
DateExpired | Date | (Deprecated) The date the Workspace expired. Will be “3000-12-31” if the Workspace never expires. |
| Navigation Properties | ||
Uri | String | The fully qualified URI for this resource. |
RelatedUris | String/StringDictionary | The list (dictionary) of related URI’s for this resource. |
Workspace API Calls
Retrieving a Single Workspace
The following API call will retrieve a single Workspace based on the Id provided.
{brillium_base_uri}/api/Accounts/{workspace_id}Retrieving All Workspaces
The following API call will retrieve all Workspaces (the Primary Workspace and all related Workspaces) accessible under the user ID provided via the Authorization token in the HTTP headers.
{brillium_base_uri}/api/AccountsRetrieving the Direct Workspaces beneath the Primary Workspace in the hierarchy
The following API call will retrieve all Workspaces under a Primary Workspace.
{brillium_base_uri}/api/Accounts/{workspace_id}/ChildrenRetrieving the Assessments for a Workspace
The following API call will retrieve all Assessments for a Workspace.
{brillium_base_uri}/api/Accounts/{workspace_id}/AssessmentsRetrieving the Respondents for a Workspace
The following API call will retrieve all Respondents for a Workspace.
{brillium_base_uri}/api/Accounts/{workspace_id}/RespondentsRetrieving the Email Templates for an Workspace
The following API call will retrieve all Email Templates for a Workspace.
{brillium_base_uri}/api/Accounts/{workspace_id}/ EmailTemplatesSample – HTTP GET Single Workspace
GET https://supersuds.brillium.com/api/Accounts/SUPERSUDSSample – Single Workspace Response (JSON)
{
"Accounts": [
{
"Id": "SUPERSUDS",
"ParentAccountId": "",
"Password": "******",
"Name": "Supersuds Corporation",
"ContactName": "John Doe",
"ContactTitle": "Instructional Designer",
"ContactAddress1": "1234 Main Street",
"ContactAddress2": "",
"ContactAddress3": "",
"ContactCity": "Anytown",
"ContactState": "NY",
"ContactPostalCode": "01234",
"ContactCountry": "USA",
"ContactPhone": "888-555-1235",
"ContactFax": "888-555-2345",
"ContactEmail": "john.doe@supersuds.com",
"DateCreated": "2002-02-21T00:00:00-05:00",
"DateModified": "2012-11-05T11:31:08-05:00",
"DateExpired": "3000-12-31T00:00:00-05:00",
"Uri": "http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS",
"RelatedUris": {
"Children":
"http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS\/Children",
"Assessments":
"http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS\/Assessments",
"Respondents":
"http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS\/Respondents",
"EmailTemplates":
"http:\/\/supersuds.brillium.com\/api\/Accounts\/SUPERSUDS\/EmailTemplates"
}
}
],
"Page": 1,
"PageSize": 50,
"TotalCount": 1,
"HasMore": false
}