Autopost

Method: list

Authorization is required. Lists all existing Autoposts in a group. The Autopost is a feed provided by the user, read regularly by the system. The eligible feed items are posted automatically in the system from the user's name

Request

HTTP request

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

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": "Esse anim incididunt duis nostrud veniam nisi ut non in duis dolor cupidatat enim.",
  "timestamp": "2014-03-03T23:20:23Z",
  "errors": {},
  "object": {
    "offset": 0,
    "autoposts": [
      {
        "type": "autopost",
        "id": 1,
        "author": {
          "id": "b77fa1be-e5d9-47d7-bfae-cd57aa1ec4f3",
          "alias": "amet do",
          "extendedAlias": "sunt dolore id commodo dolor",
          "slug": "Home",
          "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
          "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
        },
        "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/"
        },
        "url": "http://www.domain.com/rss",
        "filters": [
          "one",
          "two",
          "three"
        ],
        "sourceInfo": "Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat.",
        "nextProcessOn": "2014-03-03T23:20:23Z",
        "statusId": 0,
        "statusName": "Enabled",
        "autoApproved": true,
        "categories": [
          {
            "id": 1,
            "name": "veniam"
          },
          {
            "id": 2,
            "name": "laborum"
          },
          {
            "id": 3,
            "name": "fugiat"
          },
          {
            "id": 4,
            "name": "dolore"
          },
          {
            "id": 5,
            "name": "cillum"
          }
        ],
        "accessWarnings": []
      }
    ]
  }
}

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

property	value	description
id	integer	The autopost Id
author	object	Some common properties of the user that performed the action: id, alias, extendedAlias, slug, avatarUrl, url (of the profile page)
group	object	Some common properties of the group: id, name, slug, thumbUrl, url (of the group home page)
url	string	the feed's URL
filters	string	Comma separated list of category names, which will be matched to the feeds category field. Used to post only certain categories from the source.
sourceInfo	string	A text submitted by the author, which will be displayed under each posted article.
nextProcessOn	date	When the feed will be processed again in date ISO 8601 string and UTC time zone
statusId	integer	The current feeds status. The alternatives are: 0 - Enabled 1 - Disabled by author 2 - Disabled by admin 3 - User has no permission to autopost or post anymore
statusName	string	Human readable status according to the list above
categories	List (object)	List of the HiveSocial categories in which the articles will be posted. The category object contains id and name

Method: update

Authorization is required. Updates an existing Autopost. The Autopost is a feed provided by the user, read regularly by the system. The eligible feed items are posted automatically in the system from the user's name

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/autopost/{autopostId}

Parameters

property	value	description
autopostId	integer	The id of the updated record

Request body

property	value	description
id	integer	the autopost Id
groupId	guid	In which group the autopost is feeding to
authorId	guid	The account Id of the autopost creator and also the author from which name the posts will be created.
autoApproved	Boolean	Should the new incoming post should be posted immediately (true) or they will need an approval (false)
categories	string	comma separated list of category IDs under which the new post will be filed
sourceInfo	string	text which will be pasted under each of the autoposted article contents. Usually used for defining the source of the article.
statusId	integer	The current feeds status. The alternatives are: 0 - Enabled 1 - Disabled by author 2 - Disabled by admin 3 - User has no permission to autopost or post anymore
url	string	the autoposted feed url

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": "url",
      "value": "",
      "message": "URL cannot be blank"
    },
    {
      "key": "targetBlank",
      "value": "",
      "message": "some sample error"
    }
  ],
  "object": {
    "type": "autopost",
    "id": 1,
    "author": {
      "id": "b77fa1be-e5d9-47d7-bfae-cd57aa1ec4f3",
      "alias": "amet do",
      "extendedAlias": "sunt dolore id commodo dolor",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "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/"
    },
    "url": "http://www.domain.com/rss",
    "filters": [
      "one",
      "two",
      "three"
    ],
    "sourceInfo": "Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat.",
    "nextProcessOn": "2011-11-11T23:20:23Z",
    "statusId": 0,
    "statusName": "Enabled",
    "autoApproved": false,
    "categories": [
      {
        "id": 1,
        "name": "veniam"
      },
      {
        "id": 2,
        "name": "laborum"
      },
      {
        "id": 3,
        "name": "fugiat"
      },
      {
        "id": 4,
        "name": "dolore"
      },
      {
        "id": 5,
        "name": "cillum"
      }
    ],
    "accessWarnings": []
  }
}

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

property	value	description
id	integer	the autopost Id
groupId	guid	In which group the autopost is feeding to
authorId	guid	The account Id of the autopost creator and also the author from which name the posts will be created.
autoApproved	Boolean	Should the new incoming post should be posted immediately (true) or they will need an approval (false)
categories	string	comma separated list of category IDs under which the new post will be filed
sourceInfo	string	text which will be pasted under each of the autoposted article contents. Usually used for defining the source of the article.
statusId	integer	The current feeds status. The alternatives are: 0 - Enabled 1 - Disabled by author 2 - Disabled by admin 3 - User has no permission to autopost or post anymore
url	string	the autoposted feed url

Method: process

Authorization is required. Reads the autopost and posts all new items that are eligible for posting.

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/autopost/{autopostId}/process

Parameters

property	value	description
autopostId	integer	The 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": {
    "type": "autopost",
    "id": 1,
    "author": {
      "id": "b77fa1be-e5d9-47d7-bfae-cd57aa1ec4f3",
      "alias": "amet do",
      "extendedAlias": "sunt dolore id commodo dolor",
      "slug": "Home",
      "avatarUrl": "http://demo.hivesocialnow.com/bigavatar/bc7fbf51-7930-4550-98b0-6a3ff6111ebe.jpg",
      "url": "http://demo.hivesocialnow.com/blog/GeorgiRaykov/site/profile/"
    },
    "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/"
    },
    "url": "http://www.domain.com/rss",
    "filters": [
      "one",
      "two",
      "three"
    ],
    "sourceInfo": "Nisi proident tempor cillum sint duis eu elit dolor Lorem amet qui officia occaecat.",
    "nextProcessOn": "2011-11-11T23:20:23Z",
    "statusId": 0,
    "statusName": "Enabled",
    "autoApproved": false,
    "categories": [
      {
        "id": 1,
        "name": "veniam"
      },
      {
        "id": 2,
        "name": "laborum"
      },
      {
        "id": 3,
        "name": "fugiat"
      },
      {
        "id": 4,
        "name": "dolore"
      },
      {
        "id": 5,
        "name": "cillum"
      }
    ],
    "accessWarnings": []
  }
}

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

property	value	description
id	integer	the autopost Id
groupId	guid	In which group the autopost is feeding to
authorId	guid	The account Id of the autopost creator and also the author from which name the posts will be created.
autoApproved	Boolean	Should the new incoming post should be posted immediately (true) or they will need an approval (false)
categories	string	comma separated list of category IDs under which the new post will be filed
sourceInfo	string	text which will be pasted under each of the autoposted article contents. Usually used for defining the source of the article.
statusId	integer	The current feeds status. The alternatives are: 0 - Enabled 1 - Disabled by author 2 - Disabled by admin 3 - User has no permission to autopost or post anymore
url	string	the autoposted feed url