Group template

With the group template you can store the current configuration of a group, and reuse it in a future group creation process. The newly created groups will have preset almost all of their configuration

Method: get

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/group-template/{templateId}

Parameters

propertyvaluedescription
templateId integer The template'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": "Dolor tempor ullamco pariatur ex.",
  "errors": [],
  "object": {
    "id": "1",
    "type": "groupTemplate",
    "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/"
    },
    "name": "User generated template #1",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "typeId": 1,
    "typeName": "ea",
    "logoUrl": "http://demo.hivesocialnow.com/HS4/ContentServer/logo/78_635267293401000000.gif",
    "logoAltText": "nisi ipsum consequat reprehenderit enim",
    "logoLinkUrl": "/Home/",
    "logoVisible": true,
    "thumbUrl": "http://demo.hivesocialnow.com/HS4/ContentServer/logo/78_635267293401000000.gif",
    "thumbAltText": "duis mollit velit ea culpa",
    "favIconUrl": "http://demo.hivesocialnow.com/HS4/ContentServer/logo/78_635267293401000000.gif",
    "groupDescription": "Sunt sint excepteur ullamco elit consequat et.",
    "themeName": "Default",
    "groupEmail": "admin@admin.com",
    "groupEmailName": "reprehenderit",
    "groupEmailNewsletterName": "excepteur",
    "layoutId": 4,
    "layoutName": "two columns",
    "invitationSubject": "",
    "invitationTemplate": "",
    "commentsViewTypeId": 2,
    "commentsViewTypeName": "nisi",
    "postVoteControlVisible": false,
    "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 Template's name
description string Few words about the templates purpose, set by the template creator.
typeId integer The type Id of the future group
typeName integer The type with human readable name
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
groupDescription string HTML text which will be presented as the groups description
themeName string The theme id/name you want to be used from the future group
groupEmail string The group's webmaster email address. Used for the email generation and the contact us link
groupEmailName string the groups webmaster email name. Used for the email generation
groupEmailNewsletterName string Used when generating the group's newsletters.
layoutId integer The selected group's layout. Currently it should be always 4
layoutName string The human readable name of the layout
invitationSubject string The subject of the email that is send to invite a person to become a member of the group
invitationTemplate string The email body template that is send to invite a person to become a member of the group
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
commentsViewTypeId integer The id of the selected comment view type under the group's posts and wikis. Available options are:
  • 1 - Ordinary list. All comments are presented in the same level of hierarchy
  • 2 - Treaded list. Comments are presented in tree view format with clear hierarchy
  • 3 - Quoted list. All comments are presented in the same level of hierarchy, but there is an option to quote a comment

Method: list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/group-template/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,
    "templates": [
      {
        "id": "1",
        "type": "groupTemplate",
        "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/"
        },
        "name": "User generated template #1",
        "description": "Sunt sint excepteur ullamco elit consequat et.",
        "typeId": 1,
        "typeName": "ea",
        "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",
        "groupDescription": "Sunt sint excepteur ullamco elit consequat et.",
        "themeName": "Default",
        "groupEmail": "admin@admin.com",
        "groupEmailName": "reprehenderit",
        "groupEmailNewsletterName": "excepteur",
        "layoutId": 4,
        "layoutName": "two columns",
        "invitationSubject": "",
        "invitationTemplate": "",
        "commentsViewTypeId": 2,
        "commentsViewTypeName": "nisi",
        "postVoteControlVisible": false,
        "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.

For the specific template properties read the get method above.

Method: create

Authorization is required.

Request

HTTP request

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

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
name string The template's name
description string The template's description
groupId guid From which group to get the template's configuration

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"
    }
  ],
  "object": {
    "id": "1",
    "type": "groupTemplate",
    "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/"
    },
    "name": "tile",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "typeId": 1,
    "typeName": "ea",
    "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",
    "groupDescription": "Sunt sint excepteur ullamco elit consequat et.",
    "themeName": "Default",
    "groupEmail": "admin@admin.com",
    "groupEmailName": "reprehenderit",
    "groupEmailNewsletterName": "excepteur",
    "layoutId": 4,
    "layoutName": "two columns",
    "invitationSubject": "",
    "invitationTemplate": "",
    "commentsViewTypeId": 2,
    "commentsViewTypeName": "nisi",
    "postVoteControlVisible": false,
    "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: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/group-template/{templateId}

Parameters

propertyvaluedescription
templateId integer In id of the updated record

Request body

propertyvaluedescription
templateObj object The object of the updated template. Includes the following properties:
  • name - template name
  • description - template description
  • groupId - From which group to get the template's configuration, if the "synchConfig" is true.
synchConfig boolean If true, the template's configuration settings will be also updated with the current settings of the selected groupId. If false, only the template's name and description will be updated by 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"
    }
  ],
  "object": {
    "id": "1",
    "type": "groupTemplate",
    "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/"
    },
    "name": "tile",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "typeId": 1,
    "typeName": "ea",
    "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",
    "groupDescription": "Sunt sint excepteur ullamco elit consequat et.",
    "themeName": "Default",
    "groupEmail": "admin@admin.com",
    "groupEmailName": "reprehenderit",
    "groupEmailNewsletterName": "excepteur",
    "layoutId": 4,
    "layoutName": "two columns",
    "invitationSubject": "",
    "invitationTemplate": "",
    "commentsViewTypeId": 2,
    "commentsViewTypeName": "nisi",
    "postVoteControlVisible": false,
    "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-template/{templateId}

Parameters

propertyvaluedescription
templateId integer 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": [
    {
      "key": "name",
      "value": "",
      "message": "Name cannot be blank"
    }
  ],
  "object": {
    "id": "1",
    "type": "groupTemplate",
    "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/"
    },
    "name": "tile",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "typeId": 1,
    "typeName": "ea",
    "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",
    "groupDescription": "Sunt sint excepteur ullamco elit consequat et.",
    "themeName": "Default",
    "groupEmail": "admin@admin.com",
    "groupEmailName": "reprehenderit",
    "groupEmailNewsletterName": "excepteur",
    "layoutId": 4,
    "layoutName": "two columns",
    "invitationSubject": "",
    "invitationTemplate": "",
    "commentsViewTypeId": 2,
    "commentsViewTypeName": "nisi",
    "postVoteControlVisible": false,
    "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: synchronize

Authorization is required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/group-template/{templateId}/synch-options

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
groupId guid From which group to get the template's configuration during the synchronization.

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": "1",
    "type": "groupTemplate",
    "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/"
    },
    "name": "tile",
    "description": "Sunt sint excepteur ullamco elit consequat et.",
    "typeId": 1,
    "typeName": "ea",
    "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",
    "groupDescription": "Sunt sint excepteur ullamco elit consequat et.",
    "themeName": "Default",
    "groupEmail": "admin@admin.com",
    "groupEmailName": "reprehenderit",
    "groupEmailNewsletterName": "excepteur",
    "layoutId": 4,
    "layoutName": "two columns",
    "invitationSubject": "",
    "invitationTemplate": "",
    "commentsViewTypeId": 2,
    "commentsViewTypeName": "nisi",
    "postVoteControlVisible": false,
    "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) Empty for this method
object object The newly synchronized template object