Feed

The feed generation of the group can be configured by this method.

Method: get

Authorization is required.

Request

HTTP request

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

Parameters

propertyvaluedescription
groupId guid The id of the group you want to get the feed settings

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": "groupFeedSettings",
    "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/"
    },
    "imageUrl": "http://localhost/HS4/ContentServer/rsslogo/96.jpg",
    "imageLinkUrl": "http://demo.hivesocialnow.com/Home/",
    "imageAlt": "Rss feed thumbnail",
    "ttl": 60,
    "editorEmail": "joe@joe.com",
    "webmasterEmail": "joe@joe.com",
    "skipDays": [
      {
        "name": "Monday",
        "selected": true
      },
      {
        "name": "Tuesday",
        "selected": false
      },
      {
        "name": "Wednesday",
        "selected": true
      },
      {
        "name": "Thursday",
        "selected": false
      },
      {
        "name": "Friday",
        "selected": false
      },
      {
        "name": "Saturday",
        "selected": false
      },
      {
        "name": "Sunday",
        "selected": false
      }
    ],
    "skipHours": [
      {
        "name": "1:00",
        "selected": false
      },
      {
        "name": "2:00",
        "selected": false
      },
      {
        "name": "3:00",
        "selected": false
      },
      {
        "name": "4:00",
        "selected": false
      },
      {
        "name": "5:00",
        "selected": false
      },
      {
        "name": "6:00",
        "selected": false
      },
      {
        "name": "7:00",
        "selected": false
      },
      {
        "name": "8:00",
        "selected": false
      },
      {
        "name": "9:00",
        "selected": false
      },
      {
        "name": "10:00",
        "selected": false
      },
      {
        "name": "11:00",
        "selected": false
      },
      {
        "name": "12:00",
        "selected": false
      },
      {
        "name": "13:00",
        "selected": false
      },
      {
        "name": "14:00",
        "selected": false
      },
      {
        "name": "15:00",
        "selected": false
      },
      {
        "name": "16:00",
        "selected": false
      },
      {
        "name": "17:00",
        "selected": false
      },
      {
        "name": "18:00",
        "selected": true
      },
      {
        "name": "19:00",
        "selected": false
      },
      {
        "name": "20:00",
        "selected": false
      },
      {
        "name": "21:00",
        "selected": false
      },
      {
        "name": "22:00",
        "selected": false
      },
      {
        "name": "23:00",
        "selected": false
      },
      {
        "name": "24:00",
        "selected": false
      }
    ],
    "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 some common properties of the group in which the record was created: id, name, slug, thumbUrl, url (of the group home page)
imageUrl string The feed image. Maximum value for image width is 144px and maximum height is 400px.
imageLinkUrl string The feed image link URL.
imageAlt string The feed image alternative text.
ttl integer The interval in which the Feed reader should check back for new items.
editorEmail string The email of the content editor.
webmasterEmail string The email of the content webmaster.
skipDays list (object) In which days the feed reader should skip checking for new content.
skipHours list (object) In which hours during the day, the feed reader should skip checking for new content.

Method: update

Authorization is required.

Request

HTTP request

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

Parameters

propertyvaluedescription
groupId guid In id of the group you need to update the feed settings

Request body

propertyvaluedescription
imageUrl string The feed image. Maximum value for image width is 144px and maximum height is 400px.
imageLinkUrl string The feed image link URL.
imageAlt string The feed image alternate text.
ttl integer The interval in which the Feed reader should check back for new items.
editorEmail string The email of the content editor.
webmasterEmail string The email of the content webmaster.
skipDays list (object) In which days the feed reader should skip checking for new content.
skipHours list (object) In which hours during the day, the feed reader should skip checking for new content.

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": "editorEmail",
      "value": "",
      "message": "Not an email"
    }
  ],
  "object": {
    "type": "groupFeedSettings",
    "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/"
    },
    "imageUrl": "http://localhost/HS4/ContentServer/rsslogo/96.jpg",
    "imageLinkUrl": "http://demo.hivesocialnow.com/Home/",
    "imageAlt": "Rss feed thumbnail",
    "ttl": 60,
    "editorEmail": "joe@joe.com",
    "webmasterEmail": "joe@joe.com",
    "skipDays": [
      {
        "name": "Monday",
        "selected": true
      },
      {
        "name": "Tuesday",
        "selected": true
      },
      {
        "name": "Wednesday",
        "selected": true
      },
      {
        "name": "Thursday",
        "selected": false
      },
      {
        "name": "Friday",
        "selected": false
      },
      {
        "name": "Saturday",
        "selected": false
      },
      {
        "name": "Sunday",
        "selected": false
      }
    ],
    "skipHours": [
      {
        "name": "1:00",
        "selected": true
      },
      {
        "name": "2:00",
        "selected": true
      },
      {
        "name": "3:00",
        "selected": false
      },
      {
        "name": "4:00",
        "selected": false
      },
      {
        "name": "5:00",
        "selected": false
      },
      {
        "name": "6:00",
        "selected": false
      },
      {
        "name": "7:00",
        "selected": false
      },
      {
        "name": "8:00",
        "selected": false
      },
      {
        "name": "9:00",
        "selected": false
      },
      {
        "name": "10:00",
        "selected": false
      },
      {
        "name": "11:00",
        "selected": false
      },
      {
        "name": "12:00",
        "selected": false
      },
      {
        "name": "13:00",
        "selected": false
      },
      {
        "name": "14:00",
        "selected": false
      },
      {
        "name": "15:00",
        "selected": false
      },
      {
        "name": "16:00",
        "selected": false
      },
      {
        "name": "17:00",
        "selected": false
      },
      {
        "name": "18:00",
        "selected": false
      },
      {
        "name": "19:00",
        "selected": false
      },
      {
        "name": "20:00",
        "selected": false
      },
      {
        "name": "21:00",
        "selected": false
      },
      {
        "name": "22:00",
        "selected": false
      },
      {
        "name": "23:00",
        "selected": false
      },
      {
        "name": "24:00",
        "selected": false
      }
    ],
    "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.