Theme

In HiveSocial you can apply custom themes/ skins to two main components. To each of the groups or to the personal page section.

Method: group themes list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/theme/group/list/{groupId}

Parameters

property	value	description
groupId	guid	The elements group's ID

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Est ut nisi do id labore ad enim non ipsum in.",
  "errors": [],
  "object": {
    "offset": 0,
    "themes": [
      {
        "type": "theme",
        "name": "Default",
        "thumbUrl": "http://localhost/HS4/ContentServer/App_Themes/Default/images/screenshot.png",
        "selected": true,
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

property	value	description
name	string	Name of the theme
thumbUrl	string	The theme's thumbnail URL
selected	boolean	Is this theme selected for the requested groupId

Method: select group theme

Authorization is required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/theme/group/{themeId}/select/{groupId}

Parameters

property	value	description
themeId	string	Theme name / alias
groupId	guid	The elements group's ID

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [],
  "object": {
    "type": "theme",
    "name": "Dark",
    "thumbUrl": "http://localhost/HS4/ContentServer/App_Themes/Dark/images/screenshot.png",
    "selected": true,
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

Method: personal page themes list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/theme/personal/list

Parameters

Do not supply a request parameters with this method.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Est ut nisi do id labore ad enim non ipsum in.",
  "errors": [],
  "object": {
    "offset": 0,
    "themes": [
      {
        "type": "theme",
        "name": "Default",
        "thumbUrl": "http://localhost/HS4/ContentServer/App_Themes/Default/images/screenshot.png",
        "selected": true,
        "accessWarnings": []
      }
    ]
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.

property	value	description
name	string	Name of the theme
thumbUrl	string	The theme's thumbnail URL
selected	boolean	Is this theme selected for the requested groupId

Method: select personal theme

Authorization is required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/theme/personal/{themeId}/select

Parameters

property	value	description
themeId	string	Theme name / alias

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response JSON with the following structure:

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": true,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [],
  "object": {
    "type": "theme",
    "name": "Dark",
    "thumbUrl": "http://localhost/HS4/ContentServer/App_Themes/Dark/images/screenshot.png",
    "selected": true,
    "accessWarnings": []
  }
}

The general response properties are described on the Response format page. Here are the list of the specific properties for this method.