Ping server

HiveSocial can notify other systems for new posts. This is done by the ping server functionality.

Method: get

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/ping-server/{serverId}

Parameters

property	value	description
serverId	integer	The ping server'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": 
	{
        "id": 1,
        "type": "pingServer",
        "groups": [
          {
            "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.microsoft.com",
        "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 id of the record
groups	list (object)	In which groups the ping server is enabled
url	string	the ping server service url

Method: list

Authorization is required.

Request

HTTP request

GET https://<YOUR_DOMAIN>/api/v1/en_US/ping-server/list/{groupId}

Parameters

property	value	description
groupId	guid	The for which you need the ping servers

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": 3,
    "servers": [
      {
        "id": 1,
        "type": "pingServer",
        "groups": [
          {
            "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
            "name": "fugiat",
            "slug": "Home",
            "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
            "url": "http://demo.hivesocialnow.com/Home/"
          }
        ],
        "url": "http://www.microsoft.com",
        "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 ping server Id
groups	list (object)	for which groups this ping server is enabled
url	string	the ping service URL

Method: create

Authorization is required. Can be executed only by root group administrators

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/ping-server

Parameters

Do not supply a request parameters with this method.

Request body

property	value	description
url	string	The ping service 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"
    }
  ],
  "object": {
    "id": 1,
    "type": "pingServer",
    "groups": [
      {
        "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
        "name": "fugiat",
        "slug": "Home",
        "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
        "url": "http://demo.hivesocialnow.com/Home/"
      }
    ],
    "url": "http://www.microsoft.com11",
    "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
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. Can be executed only by root group administrators

Request

HTTP request

PUT https://<YOUR_DOMAIN>/api/v1/en_US/ping-server/{serverId}

Parameters

property	value	description
serverId	integer	In id of the updated record

Request body

property	value	description
url	string	The URL of the ping service

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"
    }
  ],
  "object": {
    "id": 1,
    "type": "pingServer",
    "groups": [
      {
        "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
        "name": "fugiat",
        "slug": "Home",
        "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
        "url": "http://demo.hivesocialnow.com/Home/"
      }
    ],
    "url": "http://www.microsoft.com11",
    "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
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. Only root system administrators can execute this method.

Request

HTTP request

DELETE https://<YOUR_DOMAIN>/api/v1/en_US/ping-server/{serverId}

Parameters

property	value	description
serverId	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": 1,
    "type": "pingServer",
    "groups": [
      {
        "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
        "name": "fugiat",
        "slug": "Home",
        "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
        "url": "http://demo.hivesocialnow.com/Home/"
      }
    ],
    "url": "http://www.microsoft.com11",
    "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
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: change status

Authorization is required. Can be executed only by the requested group administrators

Request

HTTP request

POST https://<YOUR_DOMAIN>/api/v1/en_US/ping-server/{serverId}/group/{groupId}

Parameters

property	value	description
serverId	integer	the ping server Id for which the status is changed
groupId	guid	In which group the status is changed

Request body

property	value	description
isEnabled	boolean	What is the status for this group

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": "pingServer",
    "groups": [
      {
        "id": "e532e792-4101-4ef5-8cd7-68380bbbc703",
        "name": "fugiat",
        "slug": "Home",
        "thumbUrl": "http://demo.hivesocialnow.com/logo/72_635267855582630000.png",
        "url": "http://demo.hivesocialnow.com/Home/"
      }
    ],
    "url": "http://www.microsoft.com11",
    "accessWarnings": []
  }
}

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