Category

Method: list

Authorization is required. Category item relates to the post and wiki items only.

Request

HTTP request

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

Parameters

propertyvaluedescription
groupId guid The category 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": "Irure labore eiusmod eiusmod aliquip ea anim esse aute consectetur adipisicing.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": [],
  "object": {
    "offset": 0,
    "categories": [
      {
        "id": 3,
        "type": "category",
        "group": {
          "id": "472c255a-9bb3-43a1-88bc-b341c76b3e76",
          "name": "eu",
          "slug": "Home",
          "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
          "url": "http://demo.hivesocialnow.com/Home/"
        },
        "name": "nostrud veniam",
        "description": "Incididunt duis dolor dolore ut proident ",
        "categoryTypeId": 1,
        "categoryTypeName": "Default",
        "position": 1,
        "userRoleId": 5,
        "userRoleName": "regular",
        "postCount": 2,
        "wikiCount": 5,
        "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 How this category will be presented to the end user
description string This text will appear on the category view page above the post's or wiki's list. Could be HTML.
categoryTypeId integer Category types is a way of grouping the categories in the category list module. A category has always a category type, as there is a "Default" one.
userRoleId integer This points out which user roles can post into this category. Relevant to the create post/wiki screen and its post categories section.
postCount integer How many posts are posted into this category
wikiCount integer How many wikis are posted into this category

Method: create

Authorization is required. Category item relates to the post and wiki items only.

Request

HTTP request

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

Parameters

Do not supply a request parameters with this method.

Request body

propertyvaluedescription
groupId guid In which group to create the record
name string How this category will be presented to the end user
description string This text will appear on the category view page above the post's or wiki's list. Could be HTML.
categoryTypeId integer Category types is a way of grouping the categories in the category list module. A category has always a category type, as there is a "Default" one.
position integer The category place in the categories list module
userRoleId integer This points out which user roles can post into this category. Relevant to the create post/wiki screen and its post categories section.

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": 6,
    "type": "category",
    "group": {
      "id": "6920ebce-33d6-4276-ae82-c541b80e6176",
      "name": "deserunt",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "name": "irure sunt",
    "description": "Ex velit sunt exercitation Lorem est velit sit veniam exercitation.",
    "categoryTypeId": 5,
    "categoryTypeName": "anim",
    "position": 6,
    "userRoleId": 2,
    "userRoleName": "regular",
    "postCount": 2,
    "wikiCount": 5,
    "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 How this category will be presented to the end user
description string This text will appear on the category view page above the post's or wiki's list. Could be HTML.
categoryTypeId integer Category types is a way of grouping the categories in the category list module. A category has always a category type, as there is a "Default" one.
userRoleId integer This points out which user roles can post into this category. Relevant to the create post/wiki screen and its post categories section.
postCount integer How many posts are posted into this category
wikiCount integer How many wikis are posted into this category

Method: update

Authorization is required.

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/category/{categoryId}

Parameters

propertyvaluedescription
categoryId integer In id of the updated record

Request body

propertyvaluedescription
groupId guid In which group to create the record
name string How this category will be presented to the end user
description string This text will appear on the category view page above the post's or wiki's list. Could be HTML.
categoryTypeId integer Category types is a way of grouping the categories in the category list module. A category has always a category type, as there is a "Default" one.
position integer The category place in the categories list module
userRoleId integer This points out which user roles can post into this category. Relevant to the create post/wiki screen and its post categories section.

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": 6,
    "type": "category",
    "group": {
      "id": "6920ebce-33d6-4276-ae82-c541b80e6176",
      "name": "deserunt",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "name": "irure sunt",
    "description": "Ex velit sunt exercitation Lorem est velit sit veniam exercitation.",
    "categoryTypeId": 5,
    "categoryTypeName": "anim",
    "position": 6,
    "userRoleId": 2,
    "userRoleName": "regular",
    "postCount": 2,
    "wikiCount": 5,
    "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 How this category will be presented to the end user
description string This text will appear on the category view page above the post's or wiki's list. Could be HTML.
categoryTypeId integer Category types is a way of grouping the categories in the category list module. A category has always a category type, as there is a "Default" one.
userRoleId integer This points out which user roles can post into this category. Relevant to the create post/wiki screen and its post categories section.
postCount integer How many posts are posted into this category
wikiCount integer How many wikis are posted into this category

Method: delete

Authorization is required.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/category/{categoryId}

Parameters

propertyvaluedescription
categoryId 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": [],
  "object": {
    "id": 6,
    "type": "category",
    "group": {
      "id": "6920ebce-33d6-4276-ae82-c541b80e6176",
      "name": "deserunt",
      "slug": "Home",
      "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
      "url": "http://demo.hivesocialnow.com/Home/"
    },
    "name": "irure sunt",
    "description": "Ex velit sunt exercitation Lorem est velit sit veniam exercitation.",
    "categoryTypeId": 5,
    "categoryTypeName": "anim",
    "position": 6,
    "userRoleId": 2,
    "userRoleName": "regular",
    "postCount": 2,
    "wikiCount": 5,
    "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