Meta data

Many times, for the group page's meta data, you need much finer control. This control needs to allow not only the root administrators to access the meta information, but also the group admins.

Method: list

Authorization is required.

Request

HTTP request

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

Parameters

propertyvaluedescription
groupId guid The bookmarks 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:

{
  "success": true,
  "message": "Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "type": "metadata",
    "group": {
      "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/"
    },
    "title": "Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat.",
    "systemTags": [
      {
        "id": 1,
        "name": "verify-v1",
        "content": "/K4MlCMIaELQ6hi01doI6/gVGAXxy7mWta11ZaAGoi8=",
        "allowOverride": true
      },
      {
        "id": 2,
        "name": "y_key",
        "content": "acf86b2293d635af9211",
        "allowOverride": false
      }
    ],
    "groupTags": [
      {
        "id": 1,
        "name": "verify-v1",
        "content": "/K4MlCMIaELQ6hi01doI6/gVGAXxy7mWta11ZaAGoi8="
      },
      {
        "id": 2,
        "name": "y_key",
        "content": "acf8622b93d635af9211"
      },
      {
        "id": 3,
        "name": "keywords",
        "content": "group,keywords,meta"
      }
    ],
    "accessWarnings": []
  }
}

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

propertyvaluedescription
group object The object of the group you are getting the metadata for
title string The general page title meta tag. On some special pages (e.g. post view page) it is overrided.
systemTags list (object) The list of all system wide meta tags as objects. These tags can be overrided, if there is a group tag with the same name. They have the following properties:
  • id - id of the system meta tag
  • name - "name" attribute of the tag
  • content - the value of the "content" field of the tag
  • allowOverride - boolean. Whether to force this tag over any group one with the same name.
groupTags list (object) The list of all system wide meta tags as objects. These tags can be overrided, if there is a group tag with the same name. They have the following properties:
  • id - id of the group meta tag
  • name - "name" attribute of the tag. If there is a system tag with the same name and its allowOverride is false, the group tag will override the system tag.
  • content - the value of the "content" field of the tag

Method: update page title

Authorization is required.

Request

HTTP request

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

Parameters

propertyvaluedescription
groupId guid The Id of the group which page title you want to update

Request body

propertyvaluedescription
title string The title value

Response

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

{
  "timestamp": "2014-03-03T23:20:23Z",
  "success": false,
  "message": "Aliqua anim consequat amet cupidatat proident amet amet.",
  "errors": [
    {
      "key": "title",
      "value": "",
      "message": "Title cannot be blank"
    }
  ],
  "object": {
    "title": "11 Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat."
  }
}

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

Method: create system tag

Authorization is required. User should be a root group administrator

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/metadata/system-tag

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
name string "name" attribute of the meta tag
content string "content" attribute of the meta tag
allowOverride boolean whether a group tag with the same name is allowed to override this system tag

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": "content",
      "value": "",
      "message": "Content cannot be blank"
    }
  ],
  "object": {
    "id": 1,
    "name": "verify-v1",
    "content": "111111/K4MlCMIaELQ6hi01doI6/gVGAXxy7mWtak0ZaAGoi8=",
    "allowOverride": true
  }
}

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

Method: update system tag

Authorization is required. User should be a root group administrator

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/metadata/system-tag/{tagId}

Parameters

propertyvaluedescription
tagId integer In id of the updated record

Request body

propertyvaluedescription
name string "name" attribute of the meta tag
content string "content" attribute of the meta tag
allowOverride boolean whether a group tag with the same name is allowed to override this system tag

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": "content",
      "value": "",
      "message": "Content cannot be blank"
    }
  ],
  "object": {
    "id": 1,
    "name": "verify-v1",
    "content": "111111/K4MlCMIaELQ6hi01doI6/gVGAXxy7mWtak0ZaAGoi8=",
    "allowOverride": true
  }
}

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 system tag

Authorization is required. User should be a root group administrator

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/metadata/system-tag/{tagId}

Parameters

propertyvaluedescription
tagId integer In id of the updated 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": 1,
    "name": "verify-v1",
    "content": "111111/K4MlCMIaELQ6hi01doI6/gVGAXxy7mWtak0ZaAGoi8=",
    "allowOverride": true
  }
}

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: create group tag

Authorization is required.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/metadata/group-tag/group/{groupId}

Parameters

propertyvaluedescription
groupId guid In id of the group that you want to create a group meta data tag for

Request body

propertyvaluedescription
name string "name" attribute of the meta tag. If this value is equal to the name property of a system tag, it will override it (unless the override is specifically forbidden by the system tag)
content string "content" attribute of the meta tag

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,
    "name": "verify-v1",
    "content": "/K4MlCMIaELQ6hi01doI6/gVGAXxy7mWtak0ZaAGoi8="
  }
}

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

Method: update group tag

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/metadata/group-tag/{tagId}

Parameters

propertyvaluedescription
tagId integer In id of the updated record

Request body

propertyvaluedescription
name string "name" attribute of the meta tag
content string "content" attribute of the meta tag

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,
    "name": "verify-v1",
    "content": "/K4MlCMIaELQ6hi01doI6/gVGAXxy7mWtak0ZaAGoi8="
  }
}

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 group tag

Authorization is required.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/metadata/group-tag/{tagId}

Parameters

propertyvaluedescription
tagId integer In id of the updated 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": 1,
    "name": "verify-v1",
    "content": "/K4MlCMIaELQ6hi01doI6/gVGAXxy7mWtak0ZaAGoi8="
  }
}

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