Group

In HiveSocial the group is the main element around which you can build your communities. It has its own access policy, posts, wikis, files, events, accounts, users and etc.

Method: create

Authorization is required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/group

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
name string Group's name
slug string An URL compliant string that will be part of the group's permalink
private boolean Whether this group is private or not
premium boolean If this group is subscribed to at least one enabled premium package.
invisibleInGroupListModule boolean To hide this group from the group list modules
description string HTML text which will be presented as the groups description
logoUrl string The URL of the group's logo image
logoAltText string alternative text for the group's logo
logoLinkUrl string If empty the group's home page will be set as the logo link. If not empty, you should provide a static or relative URL.
logoVisible boolean Whether to show the group's logo or not
thumbUrl string Group's thumbnail image URL. The thumbnail is mostly used to represent the group in various group lists.
thumbUrl string The group's logo alternative text
favIconUrl string The group's favicon.ico file URL
typeId integer If you want to categorize your groups by type, this is should be the id of the selected type. If you do not want to do that or you want to use the default, this property should be equal to 0.
postVoteControlVisible boolean Whether to show the vote control on posts.
postTweetControlVisible boolean Whether to show the tweet control on posts, events or announcements.
postShareControlVisible boolean Whether to show the share control on posts, events or announcements.
postStatusVisible boolean Enable post statuses for this group. The statuses are:
  • New
  • Escalated
  • Resolved
  • Reopened

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": [
    {
      "key": "name",
      "value": "",
      "message": "Name cannot be blank"
    },
    {
      "key": "thumbUrl",
      "value": "",
      "message": "private error"
    }
  ],
  "object": {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
}

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

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was created. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: create from template

Authorization is required. When creating a group, you also have the alternative to use a group template in the creation process. This will apply the predefined templates settings for the new group.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/group/from-template

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
groupName string Group's name
groupSlug string An URL compliant string that will be part of the group's permalink
templateId integer Id of the selected template
parentGroupId guid The id of a group, that you need to be the parent of the currently created one.

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": [
    {
      "key": "name",
      "value": "",
      "message": "Name cannot be blank"
    },
    {
      "key": "thumbUrl",
      "value": "",
      "message": "private error"
    }
  ],
  "object": {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
}

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

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was created. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: get

Authorization is required.

Request

HTTP request

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

Parameters

propertyvaluedescription
groupId guid The 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": [
    {
      "key": "name",
      "value": "",
      "message": "Name cannot be blank"
    },
    {
      "key": "thumbUrl",
      "value": "",
      "message": "private error"
    }
  ],
  "object": {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium":false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
}

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

propertyvaluedescription
name string Group's name
slug string An URL compliant string that will be part of the group's permalink
private boolean Whether this group is private or not
premium boolean If this group is subscribed to at least one enabled premium package.
invisibleInGroupListModule boolean To hide this group from the group list modules
description string HTML text which will be presented as the groups description
logoUrl string The URL of the group's logo image
logoAltText string alternative text for the group's logo
logoLinkUrl string If empty the group's home page will be set as the logo link. If not empty, you should provide a static or relative URL.
logoVisible boolean Whether to show the group's logo or not
thumbUrl string Group's thumbnail image URL. The thumbnail is mostly used to represent the group in various group lists.
thumbUrl string The group's logo alternative text
favIconUrl string The group's favicon.ico file URL
typeId integer If you want to categorize your groups by type, this is should be the id of the selected type. If you do not want to do that or you want to use the default, this property should be equal to 0.
postVoteControlVisible boolean Whether to show the vote control on posts.
postTweetControlVisible boolean Whether to show the tweet control on posts, events or announcements.
postShareControlVisible boolean Whether to show the share control on posts, events or announcements.
postStatusVisible boolean Enable post statuses for this group. The statuses are:
  • New
  • Escalated
  • Resolved
  • Reopened

Method: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/group/{groupId}

Parameters

propertyvaluedescription
groupId guid In id of the updated group

Request body

propertyvaluedescription
name string Group's name
slug string An URL compliant string that will be part of the group's permalink
private boolean Whether this group is private or not
premium boolean If this group is subscribed to at least one enabled premium package.
invisibleInGroupListModule boolean To hide this group from the group list modules
description string HTML text which will be presented as the groups description
logoUrl string The URL of the group's logo image
logoAltText string alternative text for the group's logo
logoLinkUrl string If empty the group's home page will be set as the logo link. If not empty, you should provide a static or relative URL.
logoVisible boolean Whether to show the group's logo or not
thumbUrl string Group's thumbnail image URL. The thumbnail is mostly used to represent the group in various group lists.
thumbUrl string The group's logo alternative text
favIconUrl string The group's favicon.ico file URL
typeId integer If you want to categorize your groups by type, this is should be the id of the selected type. If you do not want to do that or you want to use the default, this property should be equal to 0.
postVoteControlVisible boolean Whether to show the vote control on posts.
postTweetControlVisible boolean Whether to show the tweet control on posts, events or announcements.
postShareControlVisible boolean Whether to show the share control on posts, events or announcements.
postStatusVisible boolean Enable post statuses for this group. The statuses are:
  • New
  • Escalated
  • Resolved
  • Reopened

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": [
    {
      "key": "name",
      "value": "",
      "message": "Name cannot be blank"
    },
    {
      "key": "thumbUrl",
      "value": "",
      "message": "private error"
    }
  ],
  "object": {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
}

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

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) List of validation errors, if any. The "key" property value is matched to one of the record's fields
object object The object that caused the validation errors or that was updated. Have in mind that, if the server requires string trimming or data manipulation after the user submission, it is applied in this object. In this way the returned object can differe from the posted one.

Method: delete

Authorization is required.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/group/{groupId}

Parameters

propertyvaluedescription
groupId guid In id of the deleted record

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": {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
}

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

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) This list very rarely contains records during delete method processing
object object The object that was deleted

Method: list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/group/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:

{
  "success": true,
  "message": "Ad tempor cupidatat irure aliqua duis officia voluptate dolor aliquip.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 0,
    "groups": [
 {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
    ]
  }
}

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

The specific properties of the group object can be reviewed in one of the methods above.

Method: subgroups list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/group/{groupId}/subgroup/list?offset={offset}&pageSize={pageSize}

Parameters

propertyvaluedescription
groupId guid The group's ID
offset integer Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response.
pageSize integer How many records to be returned by the system. Usually 15

Request body

Do not supply a request body with this method.

Response

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

{
  "success": true,
  "message": "Ad tempor cupidatat irure aliqua duis officia voluptate dolor aliquip.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 0,
    "groups": [
 {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
    ]
  }
}

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

The specific properties of the group object can be reviewed in one of the methods above.

Method: deleted subgroups list

Authorization is required. Deleted groups are still kept in the database until they are purged

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/group/{groupId}/subgroup/deleted?offset={offset}&pageSize={pageSize}

Parameters

propertyvaluedescription
groupId guid The group's ID
offset integer Needed for the infinite scroll functionality. It is the ID of the last presented item to the user. After the request list is generated the system will skip all records from the beginning up to the record with the provided ID (including it). The next batch of records will be returned in the response.
pageSize integer How many records to be returned by the system. Usually 15

Request body

Do not supply a request body with this method.

Response

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

{
  "success": true,
  "message": "Ad tempor cupidatat irure aliqua duis officia voluptate dolor aliquip.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 0,
    "groups": [
 {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
    ]
  }
}

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

The specific properties of the group object can be reviewed in one of the methods above.

Method: deleted group purge

Authorization is required. This method will completely remove from the database, a single group that was deleted for more than 1 month.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/group/{groupId}/purge

Parameters

propertyvaluedescription
groupId guid In id of the purged group

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": 
  {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
}

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

propertyvaluedescription
success Boolean Whether the requested operation is successful or not
message String Human readable error information
errors List (object) This list very rarely contains records during delete method processing
object object The object that was purged

Method: purge all deleted subgroups

Authorization is required. This method will completely remove all subgroups deleted for more than 1 month.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/group/{groupId}/subgroup/purge-deleted

Parameters

propertyvaluedescription
groupId guid The group's ID which deleted subgroups you want to purge

Request body

Do not supply a request body with this method.

Response

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

{
  "object": null,
  "timestamp": "2014-06-19T14:02:12.5878828+03:00",
  "success": true,
  "message": "The groups were successfully purged!",
  "errors": []
}

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

Method: undelete group

Authorization is required. When deleted, a group can be restored again, until it is purged.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/group/{groupId}/undelete

Parameters

propertyvaluedescription
groupId guid The group's ID which deleted subgroups you want to purge

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": 
 {
    "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
    "type": "group",
    "createdOn": "2014-03-03T23:20:23Z",
    "author": {
      "id": "800f8ad2-7ffd-479a-9428-68a8132191ce",
      "alias": "proident est",
      "extendedAlias": "Lorem eiusmod sint aliquip do",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "slug": "home",
    "url": "http://demo.hivesocialnow.com/Home/",
    "name": "Home",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "parent": {
      "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
      "name": "home",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "typeId": 2,
    "typeName": "ea",
    "private": true,
	"premium": false,
    "invisibleInGroupListModule": true,
    "logoUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "/HS4/ContentServer/logo/78_635267293401000000.gif",
    "postVoteControlVisible": true,
    "postTweetControlVisible": false,
    "postShareControlVisible": true,
    "postStatusVisible": true,
    "accessWarnings": []
  }
}

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

The specific properties of the group object can be reviewed in one of the methods above.